SceneEntityView

Description

abstract class Tinman.Engine.Scenes.SceneEntityView
→ <TSceneView ^ref : ISceneView>

Derived from: SceneObject ^abstract
ISceneEntityView
Extended by: CameraBase ^abstract
CameraFree ^sealed
CompassView ^sealed
Example_SceneEntityView ^sealed
Example_SpatialCallback ^sealed
OffscreenView ^sealed
ScreenGizmo ^sealed

Abstract base class for ISceneEntityView implementations.

The default implementation of ISceneEntityView.QueryScreen produces no query results. The ISceneObject.QuerySceneObjectResult method will generate a SceneEntityViewResult for this scene entity view.

The default implementation of SceneObject.DirtyStateCheck checks if the ISceneObject.Enabled property of ISceneEntityView.Owner has changed and calls SceneObject.DirtyState in that case. In effect, the SceneObject.DoUpdateState will be called if the owning scene entity is enabled or disabled, which make the SceneView.Enabled and SceneView.Visible helpers work as expected.

protected constructor SceneEntityView → (1)

callbackMask ⁱⁿ : SceneObjectCallback: The value for ISceneObject.CallbackMask.

Creates a new instance of SceneEntityView.

_4 overloads

protected method ScreenLabel¹ → (2)

label ⁱⁿ : IScreenLabel: The label to add.
world ⁱⁿ : Vec3D: The world coordinates.
returns → int32: The ordinal of the added screen label or 0 if no screen label has been added, see ScreenLabelPlacement.Add.

Convenience method that adds a screen label centered at the given world coordinates.

protected method ScreenLabel² → (3)

label ⁱⁿ : IScreenLabel: The label to add.
world ⁱⁿ : Vec3D: The world coordinates.
anchor ⁱⁿ : Vec2F: The label anchor.
returns → int32: The ordinal of the added screen label or 0 if no screen label has been added, see ScreenLabelPlacement.Add.

Convenience method that adds a screen label centered at the given world coordinates.

protected method ScreenLabel³ → (2)

label ⁱⁿ : IScreenLabel: The label to add.
screen ⁱⁿ : Vec3F: The screen coordinates.
returns → int32: The ordinal of the added screen label or 0 if no screen label has been added, see ScreenLabelPlacement.Add.

Convenience method that adds a screen label centered at the given screen coordinates.

protected method ScreenLabel⁴ → (3)

label ⁱⁿ : IScreenLabel: The label to add.
screen ⁱⁿ : Vec3F: The screen coordinates.
anchor ⁱⁿ : Vec2F: The label anchor.
returns → int32: The ordinal of the added screen label or 0 if no screen label has been added, see ScreenLabelPlacement.Add.

Convenience method that adds a screen label centered at the given screen coordinates.

protected attribute graphics → (Graphics)

The currently attached graphics object.

protected attribute sceneView → (TSceneView)

The currently attached ISceneView or null if not attached.