ISceneDataTree

Description

interface Tinman.Engine.Scenes.Data.ISceneDataTree

Extended by: ISceneDataContent
ISceneDataNode

Base interface for classes that represent items in the scene database tree.

Public / Attributes

Bounds

public attribute Bounds → (get)

value : ISceneDataBounds: The spatial bounds or null to use the bounds of Parent.

Returns the spatial bounds of this scene database tree item.

ContentFlags

public attribute ContentFlags → (get)

value : SceneDataFlags: The scene data flags.

The combined scene data flags that indicate which data items are present in this scene database tree item.

Name

public attribute Name → (get)

value : string: The non-empty name or null.

Optional name of this scene database tree item.

Owner

[Constant]
public attribute Owner → (get)

value : ISceneData: [not-null]
The scene data root.

Returns the root ISceneData object which owns this scene database tree item.

Parent

[Constant]
public attribute Parent → (get)

value : ISceneDataNode: The parent node or null iff this scene database tree item is the root.

The parent scene database node or null.

ToNode

[Constant]
public attribute ToNode → (get)

value : ISceneDataNode: [not-null]
The ISceneDataNode object.

Returns the ISceneDataNode that corresponds to this scene database tree item.

Extensions

BuildGeometry

public static method BuildGeometry → (4)

which ⁱⁿ : int32: Chooses for which aspect to build a 3D model.
colorLine ^opt : int64 = Colors.Red: The line color.
colorFill ^opt : int64 = Colors.Red & Colors.Opaque10: The fill color.
lineThickness ^opt : float32 = 1: The line thickness.
returns → IModelGeometrySimple: The built IModelGeometrySimple object or null if the bounds are empty.

Builds a 3D model for the spatial database bounds.

BuildShape

public static method BuildShape → (6)

which ⁱⁿ : int32: Chooses the bounds for which to build a shape:
0 : ISceneDataBounds.ProjectedBox if defined, otherwise ISceneDataBounds.GeographicBox,
1 : ISceneDataBounds.ProjectedBox,
2 : ISceneDataBounds.GeographicBox
colorFill ^opt : int64 = Colors.Red & Colors.Opaque10: The fill color of the shape interior, see ColorRamp.Shape.
colorBorder ^opt : int64 = Colors.Red: The color of the border line, see ColorRamp.Shape.
borderThickness ^opt : float64 = 1: The thickness of the shape border, see ColorRamp.Shape.
borderStipple ^opt : LineStipple = default(LineStipple): The shape border stipple, see PixelPyramidShape.Rasterize³.
layer ^opt : int32 = 0: The shape layer, see PixelPyramidShape.For.
returns → PixelPyramidShape: The created PixelPyramidShape or null if the shape would be empty or not visible.

Builds a PixelPyramidShape for the scene database bounds.

This method is a helper for visualizing ISceneDataBounds.GeographicBox or ISceneDataBounds.ProjectedBox.

See also: SceneDataBounds.BuildShape¹
SceneDataBounds.BuildShape²

NamePath

public static method NamePath → (1)

ancestor ^opt : ISceneDataTree = null: The ancestor tree item or null for the root node.
returns → string: The name path. Will be empty if all names are null.

Returns the path of all non-null names separated by slashes, starting at the given ancestor ^opt.

This method constructs the name path from scratch, without any caching. To avoid unnecessary memory allocation pressure, callers should try to cache the result where possible.