Meta_Marker
Module: Metanodes / Definitions
A Marker is a 3D icon used to represent a clickable / draggable object in the scene - defaults to a sphere.
#include <meta_gui.hpp>
Public Types
| Type | Name |
|---|---|
| enum | AutoSelectMode { AutoSelect_Off, AutoSelect_Marker, AutoSelect_Parent, AutoSelect_Link } Values for Idx_AutoSelect. |
| enum | IDX { Idx_Enabled, Idx_Position, Idx_Style, Idx_Draggable, Idx_AutoSelect, Idx_AutoSelectLink, Idx_Unpickable, Idx_Rotation, Idx_SnapTo, Idx_SizingReference, Idx_AlignmentVector, Idx_MapOffset, Idx_SupportClipPlanes } Property index. |
| enum | SnapTo { SnapTo_Geometry, SnapTo_Plane, SnapTo_GeometryOrPlane } Values for Idx_SnapTo. |
Public Types Documentation
enum AutoSelectMode
| Enumerator | Value | Description |
|---|---|---|
| AutoSelect_Off | No tree selection when marker is clicked (Symbols - C: "AutoSelectOff", Lua: __Marker_AutoSelectOff) | |
| AutoSelect_Marker | Select the marker itself when it is clicked (Symbols - C: "AutoSelectMarker", Lua: __Marker_AutoSelectMarker) | |
| AutoSelect_Parent | Select the parent of the marker when it is clicked (Symbols - C: "AutoSelectParent", Lua: __Marker_AutoSelectParent) | |
| AutoSelect_Link | Select the node specified in Idx_AutoSelectLink (Symbols - C: "AutoSelectLink", Lua: __Marker_AutoSelectLink) |
Values for Idx_AutoSelect.
enum IDX
| Enumerator | Value | Description |
|---|---|---|
| Idx_Enabled | bool - Enables or disables the marker and its visual | |
| Idx_Position | vec3w - Position of the marker relative to its parent | |
| Idx_Style | link - A style to apply to the marker (Meta_SphericalMarkerStyle, Meta_ModelMarkerStyle, Meta_ImageMarkerStyle) | |
| Idx_Draggable | bool - Whether the marker is draggable with the mouse | |
| Idx_AutoSelect | AutoSelectMode (int) - What happens when the marker is clicked in the scene | |
| Idx_AutoSelectLink | link - When AutoSelectMode==Link, this node is selected | |
| Idx_Unpickable | bool - Whether the marker is pickable (false means the cursor cannot click on it) | |
| Idx_Rotation | vec3w - Rotation of the marker relative to its parent | |
| Idx_SnapTo | SnapTo - What to snap to when dragging | |
| Idx_SizingReference | link - Optionally specify a node whose bounding sphere is used as the reference for calculating screen scale (if the style indicates a screen sized marker) | |
| Idx_AlignmentVector | vec3w - Specifies the orientation and length when the style is set to Vector alignment mode | |
| Idx_MapOffset | float - Adjusts the texture mapping when the style uses Map Auto Scale | |
| Idx_SupportClipPlanes | bool - Should the gui item respond to clip planes |
Property index.
enum SnapTo
| Enumerator | Value | Description |
|---|---|---|
| SnapTo_Geometry | Dragging the marker snaps to whatever surface the cursor is touching (Symbols - C: "SnapToGeometry", Lua: __Marker_SnapToGeometry) | |
| SnapTo_Plane | Dragging the marker snaps to the camera-aligned plane it was on before it was dragged (Symbols - C: "SnapToPlane", Lua: __Marker_SnapToPlane) | |
| SnapTo_GeometryOrPlane | Dragging the marker snaps as per Geometry mode, but switches to Plane mode when Shift is held down (Symbols - C: "SnapToGeometryOrPlane", Lua: __Marker_SnapToGeometryOrPlane) |
Values for Idx_SnapTo.