ISceneEntity

Description

interface Tinman.Engine.Scenes.ISceneEntity

Derived from

ISceneObject
IEntityViewMask

Extended by

SceneEntityBase abstract

Represents a scene entity.

The various callback methods are invoked in the following order:

(a) - if enabled, see ISceneObject.Enabled

Public / Methods

Create​View


[OwnerReturn]
public method CreateView → (1)

sceneView in : ISceneView

[not-null]
The scene view.

returns → ISceneEntityView

The scene entity view or null for none.

Creates a new view for this scene entity.

This method will only be called if the entity view masks of this scene entity and the given sceneView in match.

The ISceneEntityView.Owner property of the returned ISceneEntityView object should return this scene entity. Then, the created scene entity view may be queried via ISceneView.ViewOf and will be removed automatically when the owning scene entity is removed from the scene. Otherwise, the implementing class is responsible for removal and may need to deal with situations where this scene entity has been removed from the scene resp. disposed, while the scene entity view is still alive.

See also

IEntityViewMask

Scene​Attach


public method SceneAttach → (1)

scene in : IScene

[not-null]
The scene.

This entity has been attached to the given scene.

RenderException

If a graphics subsystem error has occurred.

Scene​Detach


public method SceneDetach → ()

This entity has been detached from its scene.