Meta_ModelMarkerStyle

Module: Metanodes / Definitions

A ModelMarkerStyle provides styling for a marker, using a custom model instead of the default sphere.

#include <meta_gui.hpp>

Public Types

Type	Name
enum	AlignMode { AlignMode_World, AlignMode_Camera, AlignMode_Screen, AlignMode_Camera_X, AlignMode_Camera_Y, AlignMode_Camera_Z, AlignMode_Vector, AlignMode_World_Up } Values for Idx_AlignMode.
enum	DepthTestMode { DepthTestMode_Normal, DepthTestMode_ShowThrough, DepthTestMode_AlwaysOnTop } Values for Idx_DepthTestMode.
enum	HitTestMode { HitTestMode_Sphere, HitTestMode_Box } Values for Idx_HitTestMode.
enum	IDX { Idx_Visible, Idx_Size, Idx_SizeMode, Idx_AlignMode, Idx_MinimumSize, Idx_MaximumSize, Idx_Material, Idx_UseMaterialColour, Idx_Colour, Idx_Colour_hovering, Idx_Colour_pressed, Idx_Colour_highlight, Idx_Model, Idx_ModelTransform, Idx_CursorName, Idx_HitTestMode, Idx_HitTestRadius, Idx_DepthTestMode, Idx_MapAutoScale } Property index.
enum	SizeMode { SizeMode_World, SizeMode_View, SizeMode_Pixels, SizeMode_Local } Values for Idx_SizeMode.

Public Types Documentation

enum AlignMode

Enumerator	Value	Description
AlignMode_World		Aligns in world space, based on parent assembly transforms (Symbols - C: "AlignModeWorld", Lua: __ModelMarkerStyle_AlignModeWorld)
AlignMode_Camera		Aligns to the camera (Symbols - C: "AlignModeCamera", Lua: __ModelMarkerStyle_AlignModeCamera)
AlignMode_Screen		Aligns to the screen (Symbols - C: "AlignModeScreen", Lua: __ModelMarkerStyle_AlignModeScreen)
AlignMode_Camera_X		Aligns to the camera around the X axis (Symbols - C: "AlignModeCameraX", Lua: __ModelMarkerStyle_AlignModeCameraX)
AlignMode_Camera_Y		Aligns to the camera around the Y axis (Symbols - C: "AlignModeCameraY", Lua: __ModelMarkerStyle_AlignModeCameraY)
AlignMode_Camera_Z		Aligns to the camera around the Z axis (Symbols - C: "AlignModeCameraZ", Lua: __ModelMarkerStyle_AlignModeCameraZ)
AlignMode_Vector		Aligns to the vector specified on the marker (Symbols - C: "AlignModeVector", Lua: __ModelMarkerStyle_AlignModeVector)
AlignMode_World_Up		Aligns to the world up vector regardless of the parent transform hierarchy (Symbols - C: "AlignModeWorldUp", Lua: __ModelMarkerStyle_AlignModeWorldUp)

Values for Idx_AlignMode.

enum DepthTestMode

Enumerator	Value	Description
DepthTestMode_Normal		Markers are occluded by objects in front of them (Symbols - C: "DepthTestModeNormal", Lua: __ModelMarkerStyle_DepthTestModeNormal)
DepthTestMode_ShowThrough		Markers appear stippled through objects in front of them (Symbols - C: "DepthTestModeStipple", Lua: __ModelMarkerStyle_DepthTestModeStipple)
DepthTestMode_AlwaysOnTop		Markers are always rendered on top of objects (Symbols - C: "DepthTestModeAlwaysOnTop", Lua: __ModelMarkerStyle_DepthTestModeAlwaysOnTop)

Values for Idx_DepthTestMode.

enum HitTestMode

Enumerator	Value	Description
HitTestMode_Sphere		Cursor collides with a bounding sphere whose radius is set by Idx_HitTestRadius (Symbols - C: "HitTestModeSphere", Lua: __ModelMarkerStyle_HitTestModeSphere)
HitTestMode_Box		Cursor collides with the bounding box of the model (Symbols - C: "HitTestModeBox", Lua: __ModelMarkerStyle_HitTestModeBox)

Values for Idx_HitTestMode.

enum IDX

Enumerator	Value	Description
Idx_Visible		bool - Controls the visibility of all markers using this style
Idx_Size		float - Scale of the model
Idx_SizeMode		SizeMode (int) - How to size the markers
Idx_AlignMode		AlignMode (int) - Specifies the alignment mode
Idx_MinimumSize		float - Specifies the minimum view or screen size that this marker can display based on camera distance
Idx_MaximumSize		float - Specifies the maximum view or screen size that this marker can display based on camera distance
Idx_Material		link - Material to use when Idx_UseMaterialColour is true. Using a material means there are no highlight colour distinctions. (Meta_StdMaterial, Meta_GUIMaterial, Meta_WaterMaterial
Idx_UseMaterialColour		bool - When enabled, uses the material specified in Idx_Material instead of the style colours
Idx_Colour		vec4f - Default marker colour when not using a material; RGBA 0.0f to 1.0f
Idx_Colour_hovering		vec4f - Default hover colour when not using a material; RGBA 0.0f to 1.0f
Idx_Colour_pressed		vec4f - Default pressed colour when not using a material; RGBA 0.0f to 1.0f
Idx_Colour_highlight		vec4f - Default highlight colour when not using a material; RGBA 0.0f to 1.0f
Idx_Model		link - Model to use to render the markers
Idx_ModelTransform		mat4w - Transformation to apply to the model to align it as desired
Idx_CursorName		string - Name of the cursor to display when pointing at the marker. These are found in <usernode>/Cursors/Mouse/Cursor - defaults to "SceneDefault", which is the 3D cursor. "GUIDefault" is the 2D pointer.
Idx_HitTestMode		HitTestMode (int) - Specifies the hit test method used to do cursor collisions with the markers
Idx_HitTestRadius		float - Radius of the where when HitTestMode==Sphere
Idx_DepthTestMode		DepthTestMode (int) - Controls how the marker is rendered when occluded by other objects
Idx_MapAutoScale		vec3f - Optionally specifies a fixed scale to apply to textures, relative to the Marker's alignment vector

Property index.

enum SizeMode

Enumerator	Value	Description
SizeMode_World		Scale the billboard using the value in Idx_WorldScale (Symbols - C: "SizeModeWorld", Lua: __ModelMarkerStyle_SizeModeWorld)
SizeMode_View		Scale the billboard using the value in Idx_ViewScale (Symbols - C: "SizeModeView", Lua: __ModelMarkerStyle_SizeModeView)
SizeMode_Pixels		Scale the billboard using the value in Idx_PixelScale (Symbols - C: "SizeModePixels", Lua: __ModelMarkerStyle_SizeModePixels)
SizeMode_Local		Size is world units with local scaling applied (Symbols - C: "SizeModeLocal", Lua: __ModelMarkerStyle_SizeModeLocal)

Values for Idx_SizeMode.