ISceneView
Description
- Derived from
- Extended by
Represents a view into a scene.
Access to scene view functionality is provided by a hierarchy of interfaces and classes. As best practice, at a specific location in the code, the type with the highest generalization should be used:
-
ISceneView
General purpose scene view management, independent on the scene view type, not including callbacks for application loop integration. -
ISceneView2D
Scene view functionality that is specific to 2D maps. -
ISceneView3D
Scene view functionality that is specific to 3D terrains. -
SceneView
Abstract base class that provides access to the callback for application loop integration.
Public / Methods
EntityViewAdd
Adds an entity view to the scene.
The given entityView in must be compatible with this scene view. Use ISceneEntityView.SceneViewCheck to check for compatibility, if necessary.
- RenderException
-
If a graphics subsystem error has occurred.
- See also
EntityViewRemove
Removes an entity view from the scene.
The removal may be deferred, in order to avoid side-effects.
- See also
Evict
The given resource is no longer used and may be evicted from all GPU caches.
It is not necessary to call this method. However, if it is considered best practice that all scene entity views tell their scene view when a resource will never be used again, so that cleanup can be performed up-front.
NotReady
Marks this scene view as not ready.
The current please wait screen (see PleaseWait) is shown while the scene view is not ready.
ViewOf
Returns the ISceneEntityView in this scene view that is owned by the given entity in (see ISceneEntityView.Owner).
When a ISceneEntityView is added with EntityViewAdd (either automatically via ISceneEntity.CreateView or manually), its ISceneEntityView.Owner property is queried: if it has an owning ISceneEntity object, the scene view will store the relationship. The stored relationships are used to find the scene entity view that is owned by the given entity in. This implies that for each scene entity, at most one owned scene entity view can be stored.
Public / Attributes
EntityViews
The list of all scene entity views.
This is a flat list that contains all scene entity views. It is sorted in ascending order, according to the ISceneObject.Order values of the contained scene entity views.
IsReady
Is this scene view ready?
Scene readiness is calculated from the refinement progress of the terrain mesh (see IMeshDynamic.Progress) and the progress of terrain texture loading (see TerrainView.TextureProgress).
- See also