ISceneEntityView

Description

interface Tinman.Engine.Scenes.ISceneEntityView

Derived from: ISceneObject
IGraphicsComponent
IInputConsumer
IUpdateableFrameTime
IRenderPreparable
IRenderable2D
Extended by: ISceneEntityViewFocusable
SceneEntityView ^abstract

Represents the visual aspects of a scene entity for a specific scene view.

The various callback methods are invoked in the following order:

SceneViewAttach
Per life-cycle of the underlying graphics context:
1. IGraphicsComponent.GraphicsAttach
2. IGraphicsComponent.GraphicsResize
3. For each scene processing cycle:
4. IGraphicsComponent.GraphicsDetach
SceneViewDetach

Public / Methods

QueryScreen

public method QueryScreen → (2)

point ⁱⁿ : Vec2I: The point, in screen-space (see ISceneView.Bounds).
builder ⁱⁿ : ISceneQueryResultBuilder: [not-null]
The query result builder to use.

Performs a spatial query to find the 2D screen elements that contain the given point ⁱⁿ.

This method is used by ISceneQueryProvider.Query for operations created with SceneQueryOp.ForScreen.

Render3D

public method Render3D → (1)

renderer ⁱⁿ : Renderer: [not-null]
The renderer object to use.

Performs additional 3D rendering.

When this method is called the given renderer ⁱⁿ will have been prepared:

Renderer.Bounds has been set.
ILineThickness.LineThickness has been set to default.
IBeginEnd.Begin has been called.

RenderOffscreen

public method RenderOffscreen → (1)

context ⁱⁿ : IGraphicsContext: [not-null]
The graphics context to use.

Performs custom offscreen rendering.

Custom offscreen rendering may involve the following steps:

Rendering to one ore more IRenderTarget objects, by issuing rendering work via IPrimitiveRenderer. For high-level rendering work, the following helper objects may be used:
- IGraphicsContext.Graphics of context ⁱⁿ
- TerrainView.Geometry of ISceneView3D.Terrain
- TerrainView.Models of ISceneView3D.Terrain
None of the high-level helpers will have been prepared when this method is called. Implementing methods must perform preparation, for example by calling IBeginEnd.Begin and IBeginEnd.End properly.
Generating content for one or more IGpuBuffer objects, by dispatching compute work via IWorkDispatcher.Dispatch.

SceneViewAttach

public method SceneViewAttach → (1)

sceneView ⁱⁿ : ISceneView: [not-null]
The scene view.

This entity view has been attached to the given scene view.

This entity view must be compatible with the given sceneView ⁱⁿ. Use SceneViewCheck to check for compatibility, if necessary.

RenderException: If a graphics subsystem error has occurred.

See also: ISceneEntityView.SceneViewDetach

SceneViewCheck

public method SceneViewCheck → (1)

sceneView ⁱⁿ : ISceneView: [not-null]
The scene view.
returns → bool: true if this entity view is compatible with sceneView ⁱⁿ,
false if not.

Checks if this entity view can be attached to the given scene view.

SceneViewDetach

public method SceneViewDetach → ()

This entity view has been detached from its scene view.

See also: ISceneEntityView.SceneViewAttach

Public / Attributes

Owner

public attribute Owner → (get)

value : ISceneEntity: The owning scene entity or null if none.

The scene entity that owns this view.

The owning scene entity is the one that has created this scene entity view in its ISceneEntity.CreateView method. If the owning scene entity is disabled (see ISceneObject.Enabled), the owned scene entity view is also treated as if it had been disabled.

Visible

public attribute Visible → (get,set)

value : bool: true to show this scene entity view, false to hide it.

Manually shows resp. hides this scene entity view.

Scene entity views are visible by default. Hidden scene entity views are processed as usual, except that they are excluded from rendering and spatial queries. If a scene entity view is disabled, it is treated as if it had been hidden.

See also: SceneView.Visible
SceneView.Enabled