This object type renders label in scene. More...

Inheritance diagram for MR.Const_ObjectLabel:

Classes
struct	_Underlying

struct	_UnderlyingShared

Public Member Functions
virtual void	Dispose ()

unsafe	Const_ObjectLabel ()
	Constructs an empty (default-constructed) instance.

unsafe	Const_ObjectLabel (MR._ByValue_ObjectLabel _other)
	Generated from constructor `MR.ObjectLabel.ObjectLabel`.

unsafe? byte	typeName ()
	Generated from method `MR.ObjectLabel.typeName`.

unsafe bool	hasVisualRepresentation ()
	Generated from method `MR.ObjectLabel.hasVisualRepresentation`.

unsafe MR.Object	clone ()
	Generated from method `MR.ObjectLabel.clone`.

unsafe MR.Object	shallowClone ()
	Generated from method `MR.ObjectLabel.shallowClone`.

unsafe float	getFontHeight ()
	returns size of label font on screen in pixels Generated from method `MR.ObjectLabel.getFontHeight`.

unsafe MR.Const_PositionedText	getLabel ()
	Generated from method `MR.ObjectLabel.getLabel`.

unsafe MR.Std.Filesystem.Const_Path	getFontPath ()
	Generated from method `MR.ObjectLabel.getFontPath`.

unsafe ref readonly MR.Vector2f	getPivotPoint ()
	get pivot point Generated from method `MR.ObjectLabel.getPivotPoint`.

unsafe ref readonly MR.Vector2f	getPivotShift ()
	get pivot shift (pivot point * text diagonal) Generated from method `MR.ObjectLabel.getPivotShift`.

unsafe float	getLeaderLineWidth ()
	returns width of leader line in pixels Generated from method `MR.ObjectLabel.getLeaderLineWidth`.

unsafe float	getSourcePointSize ()
	returns size of source point in pixels Generated from method `MR.ObjectLabel.getSourcePointSize`.

unsafe float	getBackgroundPadding ()
	returns background padding in pixels Generated from method `MR.ObjectLabel.getBackgroundPadding`.

unsafe ref readonly MR.Color	getSourcePointColor (MR._InOpt_ViewportId id=default)
	returns color of source point Generated from method `MR.ObjectLabel.getSourcePointColor`. Parameter `id` defaults to `{}`.

unsafe ref readonly MR.Color	getLeaderLineColor (MR._InOpt_ViewportId id=default)
	return color of leader line Generated from method `MR.ObjectLabel.getLeaderLineColor`. Parameter `id` defaults to `{}`.

unsafe ref readonly MR.Color	getContourColor (MR._InOpt_ViewportId id=default)
	return contour color Generated from method `MR.ObjectLabel.getContourColor`. Parameter `id` defaults to `{}`.

unsafe MR.Const_ViewportProperty_MRColor	getSourcePointColorsForAllViewports ()
	Generated from method `MR.ObjectLabel.getSourcePointColorsForAllViewports`.

unsafe MR.Const_ViewportProperty_MRColor	getLeaderLineColorsForAllViewports ()
	Generated from method `MR.ObjectLabel.getLeaderLineColorsForAllViewports`.

unsafe MR.Const_ViewportProperty_MRColor	getContourColorsForAllViewports ()
	Generated from method `MR.ObjectLabel.getContourColorsForAllViewports`.

unsafe MR.Box3f	getWorldBox (MR._InOpt_ViewportId _1=default)
	returns cached bounding box of this label object in world coordinates; if you need bounding box in local coordinates please call getBoundingBox() Generated from method `MR.ObjectLabel.getWorldBox`. Parameter `_1` defaults to `{}`.

unsafe MR.Const_Mesh	labelRepresentingMesh ()
	returns mesh that represents current label only used in Render object for binding, cleared after it Generated from method `MR.ObjectLabel.labelRepresentingMesh`.

unsafe ulong	heapBytes ()
	returns the amount of memory this object occupies on heap Generated from method `MR.ObjectLabel.heapBytes`.

unsafe MR.Std.Vector_MRViewportMask	getAllVisualizeProperties ()
	get all visualize properties masks Generated from method `MR.ObjectLabel.getAllVisualizeProperties`.

unsafe MR.Const_ViewportMask	getVisualizePropertyMask (MR.Const_AnyVisualizeMaskEnum type)
	returns mask of viewports where given property is set Generated from method `MR.ObjectLabel.getVisualizePropertyMask`.

unsafe void	buildMeshFromText ()
	Loads font, and converts the symbols of text into mesh; since this operation is time consuming, one can call this method in parallel for several ObjectLabels before rendering Generated from method `MR.ObjectLabel.buildMeshFromText`.

unsafe MR.Std.String	className ()
	Generated from method `MR.ObjectLabel.className`.

unsafe MR.Std.String	classNameInPlural ()
	Generated from method `MR.ObjectLabel.classNameInPlural`.

unsafe bool	supportsVisualizeProperty (MR.Const_AnyVisualizeMaskEnum type)
	Returns true if this class supports the property `type`. Otherwise passing it to the functions below is illegal. Generated from method `MR.ObjectLabel.supportsVisualizeProperty`.

unsafe bool	getVisualizeProperty (MR.Const_AnyVisualizeMaskEnum type, MR.Const_ViewportMask viewportMask)
	returns true if the property is set at least in one viewport specified by the mask Generated from method `MR.ObjectLabel.getVisualizeProperty`.

unsafe MR.ViewportMask	globalClippedByPlaneMask ()
	returns all viewports where this object or any of its parents is clipped by plane Generated from method `MR.ObjectLabel.globalClippedByPlaneMask`.

unsafe bool	globalClippedByPlane (MR.Const_ViewportMask? viewportMask=null)
	returns true if this object or any of its parents is clipped by plane in any of given viewports Generated from method `MR.ObjectLabel.globalClippedByPlane`. Parameter `viewportMask` defaults to `ViewportMask.any()`.

unsafe ref readonly MR.Color	getFrontColor (bool? selected=null, MR._InOpt_ViewportId viewportId=default)
	returns color of object when it is selected/not-selected (depending on argument) in given viewport Generated from method `MR.ObjectLabel.getFrontColor`. Parameter `selected` defaults to `true`. Parameter `viewportId` defaults to `{}`.

unsafe MR.Const_ViewportProperty_MRColor	getFrontColorsForAllViewports (bool? selected=null)
	returns color of object when it is selected/not-selected (depending on argument) in all viewports Generated from method `MR.ObjectLabel.getFrontColorsForAllViewports`. Parameter `selected` defaults to `true`.

unsafe MR.Const_ViewportProperty_MRColor	getBackColorsForAllViewports ()
	returns backward color of object in all viewports Generated from method `MR.ObjectLabel.getBackColorsForAllViewports`.

unsafe ref readonly MR.Color	getBackColor (MR._InOpt_ViewportId viewportId=default)
	returns backward color of object in given viewport Generated from method `MR.ObjectLabel.getBackColor`. Parameter `viewportId` defaults to `{}`.

unsafe byte	getGlobalAlpha (MR._InOpt_ViewportId viewportId=default)
	returns global transparency alpha of object in given viewport Generated from method `MR.ObjectLabel.getGlobalAlpha`. Parameter `viewportId` defaults to `{}`.

unsafe MR.Const_ViewportProperty_UnsignedChar	getGlobalAlphaForAllViewports ()
	returns global transparency alpha of object in all viewports Generated from method `MR.ObjectLabel.getGlobalAlphaForAllViewports`.

unsafe uint	getDirtyFlags ()
	returns current dirty flags for the object Generated from method `MR.ObjectLabel.getDirtyFlags`.

unsafe void	resetDirty ()
	resets all dirty flags (except for cache flags that will be reset automatically on cache update) Generated from method `MR.ObjectLabel.resetDirty`.

unsafe void	resetDirtyExceptMask (uint mask)
	reset dirty flags without some specific bits (useful for lazy normals update) Generated from method `MR.ObjectLabel.resetDirtyExceptMask`.

unsafe MR.Box3f	getBoundingBox ()
	returns cached bounding box of this object in local coordinates Generated from method `MR.ObjectLabel.getBoundingBox`.

unsafe bool	getRedrawFlag (MR.Const_ViewportMask viewportMask)
	returns true if the object must be redrawn (due to dirty flags) in one of specified viewports Generated from method `MR.ObjectLabel.getRedrawFlag`.

unsafe bool	isPickable (MR.Const_ViewportMask? viewportMask=null)
	whether the object can be picked (by mouse) in any of given viewports Generated from method `MR.ObjectLabel.isPickable`. Parameter `viewportMask` defaults to `ViewportMask.any()`.

unsafe MR.ColoringType	getColoringType ()
	returns the current coloring mode of the object Generated from method `MR.ObjectLabel.getColoringType`.

unsafe float	getShininess ()
	returns the current shininess visual value Generated from method `MR.ObjectLabel.getShininess`.

unsafe float	getSpecularStrength ()
	returns intensity of reflections Generated from method `MR.ObjectLabel.getSpecularStrength`.

unsafe float	getAmbientStrength ()
	returns intensity of non-directional light Generated from method `MR.ObjectLabel.getAmbientStrength`.

unsafe bool	render (MR.Const_ModelRenderParams _1)
	draws this object for visualization Returns true if something was drawn. Generated from method `MR.ObjectLabel.render`.

unsafe void	renderForPicker (MR.Const_ModelBaseRenderParams _1, uint _2)
	draws this object for picking Generated from method `MR.ObjectLabel.renderForPicker`.

unsafe void	renderUi (MR.Const_UiRenderParams params_)
	draws this object for 2d UI Generated from method `MR.ObjectLabel.renderUi`.

unsafe MR.Std.Vector_StdString	getInfoLines ()
	return several info lines that can better describe the object in the UI Generated from method `MR.ObjectLabel.getInfoLines`.

unsafe bool	useDefaultScenePropertiesOnDeserialization ()
	whether the scene-related properties should get their values from SceneColors and SceneSettings instances rather than from the input data on deserialization Generated from method `MR.ObjectLabel.useDefaultScenePropertiesOnDeserialization`.

unsafe MR.Std.Const_String	name ()
	Generated from method `MR.ObjectLabel.name`.

unsafe ref readonly MR.AffineXf3f	xf (MR._InOpt_ViewportId id=default, MR.Misc.InOut< bool >? isDef=null)
	this space to parent space transformation (to world space if no parent) for default or given viewport

unsafe MR.Const_ViewportProperty_MRAffineXf3f	xfsForAllViewports ()
	returns xfs for all viewports, combined into a single object Generated from method `MR.ObjectLabel.xfsForAllViewports`.

unsafe MR.AffineXf3f	worldXf (MR._InOpt_ViewportId id=default, MR.Misc.InOut< bool >? isDef=null)
	this space to world space transformation for default or specific viewport

unsafe MR.ViewportMask	globalVisibilityMask ()
	returns all viewports where this object is visible together with all its parents Generated from method `MR.ObjectLabel.globalVisibilityMask`.

unsafe bool	globalVisibility (MR.Const_ViewportMask? viewportMask=null)
	returns true if this object is visible together with all its parents in any of given viewports Generated from method `MR.ObjectLabel.globalVisibility`. Parameter `viewportMask` defaults to `ViewportMask.any()`.

unsafe bool	isLocked ()
	object properties lock for UI Generated from method `MR.ObjectLabel.isLocked`.

unsafe bool	isParentLocked ()
	If true, the scene tree GUI doesn't allow you to drag'n'drop this object into a different parent. Defaults to false. Generated from method `MR.ObjectLabel.isParentLocked`.

unsafe bool	isAncestor (MR.Const_Object? ancestor)
	return true if given object is ancestor of this one, false otherwise Generated from method `MR.ObjectLabel.isAncestor`.

unsafe bool	isSelected ()
	Generated from method `MR.ObjectLabel.isSelected`.

unsafe bool	isAncillary ()
	Generated from method `MR.ObjectLabel.isAncillary`.

unsafe bool	isGlobalAncillary ()
	returns true if the object or any of its ancestors are ancillary Generated from method `MR.ObjectLabel.isGlobalAncillary`.

unsafe bool	isVisible (MR.Const_ViewportMask? viewportMask=null)
	checks whether the object is visible in any of the viewports specified by the mask (by default in any viewport) Generated from method `MR.ObjectLabel.isVisible`. Parameter `viewportMask` defaults to `ViewportMask.any()`.

unsafe MR.ViewportMask	visibilityMask ()
	gets object visibility as bitmask of viewports Generated from method `MR.ObjectLabel.visibilityMask`.

unsafe void	resetRedrawFlag ()
	Generated from method `MR.ObjectLabel.resetRedrawFlag`.

unsafe MR.Object	cloneTree ()
	clones all tree of this object (except ancillary and unrecognized children) Generated from method `MR.ObjectLabel.cloneTree`.

unsafe MR.Object	shallowCloneTree ()
	clones all tree of this object (except ancillary and unrecognied children) clones only pointers to mesh, points or voxels Generated from method `MR.ObjectLabel.shallowCloneTree`.

unsafe MR.Box3f	getWorldTreeBox (MR._InOpt_ViewportId _1=default)
	empty box returns bounding box of this object and all children visible in given (or default) viewport in world coordinates Generated from method `MR.ObjectLabel.getWorldTreeBox`. Parameter `_1` defaults to `{}`.

unsafe bool	hasModel ()
	does the object have any model available (but possibly empty), e.g. ObjectMesh has valid mesh() or ObjectPoints has valid pointCloud() Generated from method `MR.ObjectLabel.hasModel`.

unsafe MR.Std.Const_Set_StdString	tags ()
	provides read-only access to the tag storage the storage is a set of unique strings Generated from method `MR.ObjectLabel.tags`.

unsafe bool	sameModels (MR.Const_Object other)
	Generated from method `MR.ObjectLabel.sameModels`.

unsafe ulong	getModelHash ()
	Generated from method `MR.ObjectLabel.getModelHash`.

unsafe MR.Object	getSharedPtr ()
	Generated from method `MR.ObjectLabel.getSharedPtr`.

Static Public Member Functions
static unsafe implicit	operator MR.Const_ObjectChildrenHolder (Const_ObjectLabel self)

static unsafe implicit	operator MR.Const_Object (Const_ObjectLabel self)

static unsafe implicit	operator MR.Const_VisualObject (Const_ObjectLabel self)

static unsafe	operator Const_ObjectLabel? (MR.Const_Object parent)

static unsafe	operator Const_ObjectLabel? (MR.Const_VisualObject parent)

static unsafe? byte	staticTypeName ()
	Generated from method `MR.ObjectLabel.StaticTypeName`.

static unsafe? byte	staticClassName ()
	Generated from method `MR.ObjectLabel.StaticClassName`.

static unsafe? byte	staticClassNameInPlural ()
	Generated from method `MR.ObjectLabel.StaticClassNameInPlural`.

Protected Member Functions
unsafe void	_LateMakeShared (_Underlying *ptr)

virtual unsafe void	Dispose (bool disposing)

Properties
override unsafe bool	_IsOwning `[get]`
	Check if the underlying shared pointer is owning or not.

Properties inherited from MR.Misc.SharedObject< Const_ObjectLabel >
override bool	_IsOwning `[get]`
	This checks if the `shared_ptr` itself is owning or not, rather than whether we own our `shared_ptr`, which isn't a given. The derived classes have to implement this, since it depends on the specific `shared_ptr` type.

bool	_IsOwningSharedPtr `[get]`
	This checks if we own the underlying `shared_ptr` instance, regardless of whether it owns the underlying object, which is orthogonal. We repurpose `_IsOwningVal` for this.

Detailed Description

This object type renders label in scene.

default pivot point = (0, 0) Generated from class MR.ObjectLabel. Base classes: Direct: (non-virtual) MR.VisualObject Indirect: (non-virtual) MR.ObjectChildrenHolder MR.Object This is the const half of the class.

Member Function Documentation

◆ worldXf()

unsafe MR.AffineXf3f MR.Const_ObjectLabel.worldXf	(	MR._InOpt_ViewportId	id = default,
		MR.Misc.InOut< bool >?	isDef = null )

inline

this space to world space transformation for default or specific viewport

Parameters

isDef receives true if the object has default transformation in this viewport (same as worldXf() returns) Generated from method MR.ObjectLabel.worldXf. Parameter id defaults to {}.

◆ xf()

unsafe ref readonly MR.AffineXf3f MR.Const_ObjectLabel.xf	(	MR._InOpt_ViewportId	id = default,
		MR.Misc.InOut< bool >?	isDef = null )

inline

this space to parent space transformation (to world space if no parent) for default or given viewport

Parameters

isDef receives true if the object has default transformation in this viewport (same as xf() returns) Generated from method MR.ObjectLabel.xf. Parameter id defaults to {}.

The documentation for this class was generated from the following file:

MRObjectLabel.cs

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ worldXf()

◆ xf()