Meta_Billboard

A Billboard allows its children to be rendered in various alignment and sizing modes.

Public Types


Values for Idx_AlignMode.

AlignMode_World

Aligns in world space, based on parent assembly transforms (Symbols - C: "AlignModeWorld", Lua: __Billboard_AlignModeWorld)

AlignMode_Camera

Aligns to the camera (Symbols - C: "AlignModeCamera", Lua: __Billboard_AlignModeCamera)

AlignMode_Screen

Aligns to the screen (Symbols - C: "AlignModeScreen", Lua: __Billboard_AlignModeScreen)

AlignMode_Camera_X

Aligns to the camera around the X axis (Symbols - C: "AlignModeCameraX", Lua: __Billboard_AlignModeCameraX)

AlignMode_Camera_Y

Aligns to the camera around the Y axis (Symbols - C: "AlignModeCameraY", Lua: __Billboard_AlignModeCameraY)

AlignMode_Camera_Z

Aligns to the camera around the Z axis (Symbols - C: "AlignModeCameraZ", Lua: __Billboard_AlignModeCameraZ)


enum IDX

Property index.

Idx_Enabled

bool - When enabled, the billboard and its descendants are drawn in the scene

Idx_Target

link - Optionally specifies an assembly to align the billboard to

Idx_AlignMode

ALIGNMODE (int) - Specifies the alignment mode

Idx_PositionMode

POSITIONMODE (int) - Specifies the position mode

Idx_SizeMode

SIZEMODE (int) - Specifies the size mode

Idx_ShareMode

Unused.

Idx_WorldPosition

vec3w - When in world position mode, specifies the world translation of the billboard

Idx_WorldDepthAdjustment

float - When in world position mode, specifies a depth adjustment to bring the billboard toward or away from the viewer

Idx_ViewPosition

vec3w - When in view position mode, specifies the position of the billboard in view units (-1 to +1)

Idx_ScreenPosition

vec3w - When in screen position mode, specifies the position of the billboard in screen units (-1 to +1)

Idx_WorldScale

float - When in world size mode, specifies the world scale applied to billboard contents

Idx_ViewScale

float - When in view size mode, specifies the scale in terms of a proportion of the view

Idx_PixelScale

float - When in screen size mode, specifies the scale in terms of pixel coverage

Idx_MinimumScale

float - Specifies a minimum value after which the contents are no longer scaled down

Idx_MaximumScale

float - Specifies a maximum value after which the contents are no longer scaled up

Idx_NoCollisions

bool - Disable collisions (cursor and object) with the contents of this billboard

Idx_MaxViewDistance

world_float - Specifies the maximum distance before the billboard is no longer drawn

Idx_UseWorldUpVector

bool - When enabled, aligns the billboard using the world up vector

Idx_KeepHorizontal

bool - When enabled, the billboard alignment never allows the contents to roll


Values for Idx_PositionMode.

PositionMode_World

Position the billboard using the value in Idx_WorldPosition (Symbols - C: "PositionModeWorld", Lua: __Billboard_PositionModeWorld)

PositionMode_View

Position the billboard using the value in Idx_ViewPosition (Symbols - C: "PositionModeView", Lua: __Billboard_PositionModeView)

PositionMode_Screen

Position the billboard using the value in Idx_ScreenPosition (Symbols - C: "PositionModeScreen", Lua: __Billboard_PositionModeScreen)


Values for Idx_SizeMode.

SizeMode_World

Scale the billboard using the value in Idx_WorldScale (Symbols - C: "SizeModeWorld", Lua: __Billboard_SizeModeWorld)

SizeMode_View

Scale the billboard using the value in Idx_ViewScale (Symbols - C: "SizeModeView", Lua: __Billboard_SizeModeView)

SizeMode_Pixels

Scale the billboard using the value in Idx_PixelScale (Symbols - C: "SizeModePixels", Lua: __Billboard_SizeModePixels)

No Results.

Getting StartedArchitectureBest PracticesHow ToAdvanced TopicsChangelogvrtree_cppCoreForeign Function InterfaceMetanodesMigrationsObserversPropertiesTreeUtilitiesAPI DefinitionsVR ExchangePluginsLua API