named object in the data model Generated from class MR.Object. Base classes: Direct: (non-virtual) MR.ObjectChildrenHolder Derived classes: Direct: (non-virtual) MR.SceneRootObject MR.VisualObject Indirect: (non-virtual) MR.AddVisualProperties<MR.FeatureObject, MR.DimensionsVisualizePropertyType.diameter, MR.DimensionsVisualizePropertyType.angle, MR.DimensionsVisualizePropertyType.length> MR.AddVisualProperties<MR.FeatureObject, MR.DimensionsVisualizePropertyType.diameter, MR.DimensionsVisualizePropertyType.length> MR.AddVisualProperties<MR.FeatureObject, MR.DimensionsVisualizePropertyType.diameter> MR.AngleMeasurementObject MR.CircleObject MR.ConeObject MR.CylinderObject MR.DistanceMeasurementObject MR.FeatureObject MR.LineObject MR.MeasurementObject MR.ObjectDistanceMap MR.ObjectGcode MR.ObjectLabel MR.ObjectLines MR.ObjectLinesHolder MR.ObjectMesh MR.ObjectMeshHolder MR.ObjectPoints MR.ObjectPointsHolder MR.ObjectVoxels MR.PlaneObject MR.PointMeasurementObject MR.PointObject MR.RadiusMeasurementObject MR.SphereObject This is the non-const half of the class. More...

Inheritance diagram for MR.Object:

Public Member Functions
unsafe	Object ()
	Constructs an empty (default-constructed) instance.

unsafe	Object (MR._ByValue_Object _other)
	Generated from constructor `MR.Object.Object`.

unsafe MR.Object	assign (MR._ByValue_Object _other)
	Generated from method `MR.Object.operator=`.

unsafe new MR.? VisualObject	asType ()
	Generated from method `MR.Object.asType<MR.VisualObject>`.

unsafe void	setName (string name)
	Generated from method `MR.Object.setName`.

unsafe new MR.Object	find (string name)
	Generated from method `MR.Object.find`.

unsafe void	setXf (in MR.AffineXf3f xf, MR._InOpt_ViewportId id=default)
	Generated from method `MR.Object.setXf`. Parameter `id` defaults to `{}`.

unsafe void	resetXf (MR._InOpt_ViewportId id=default)
	forgets specific transform in given viewport (or forgets all specific transforms for {} input) Generated from method `MR.Object.resetXf`. Parameter `id` defaults to `{}`.

unsafe void	setXfsForAllViewports (MR._ByValue_ViewportProperty_MRAffineXf3f xf)
	modifies xfs for all viewports at once Generated from method `MR.Object.setXfsForAllViewports`.

unsafe void	setWorldXf (in MR.AffineXf3f xf, MR._InOpt_ViewportId id=default)
	Generated from method `MR.Object.setWorldXf`. Parameter `id` defaults to `{}`.

unsafe void	applyScale (float scaleFactor)
	scale object size (all point positions) Generated from method `MR.Object.applyScale`.

unsafe void	setGlobalVisibility (bool on, MR.Const_ViewportMask? viewportMask=null)
	if true sets all predecessors visible, otherwise sets this object invisible Generated from method `MR.Object.setGlobalVisibility`. Parameter `viewportMask` defaults to `ViewportMask.any()`.

unsafe void	setLocked (bool on)
	Generated from method `MR.Object.setLocked`.

unsafe void	setParentLocked (bool lock_)
	Generated from method `MR.Object.setParentLocked`.

unsafe new MR.? Object	parent ()
	Generated from method `MR.Object.parent`.

unsafe MR.? Object	findCommonAncestor (MR.Object other)
	Find a common ancestor between this object and the other one. Returns null on failure (which is impossible if both are children of the scene root). Will return `this` if `other` matches `this`. Generated from method `MR.Object.findCommonAncestor`.

unsafe bool	detachFromParent ()
	removes this from its parent children list returns false if it was already orphan Generated from method `MR.Object.detachFromParent`.

unsafe new MR.Std.Const_Vector_StdSharedPtrMRObject	children ()
	an object can hold other sub-objects Generated from method `MR.Object.children`.

unsafe bool	addChild (MR._ByValueShared_Object child, bool? recognizedChild=null)
	adds given object at the end of children (recognized or not); returns false if it was already child of this, of if given pointer is empty; child object will always report this as parent after the call;

unsafe bool	addChildBefore (MR._ByValueShared_Object newChild, MR.Const_Object existingChild)
	adds given object in the recognized children before existingChild; if newChild was already among this children then moves it just before existingChild keeping the order of other children intact; returns false if newChild is nullptr, or existingChild is not a child of this Generated from method `MR.Object.addChildBefore`.

unsafe bool	removeChild (MR.Const_Object child)
	returns false if it was not child of this Generated from method `MR.Object.removeChild`.

unsafe bool	removeChild (MR.Object? child)
	Generated from method `MR.Object.removeChild`.

unsafe void	removeAllChildren ()
	detaches all recognized children from this, keeping all unrecognized ones Generated from method `MR.Object.removeAllChildren`.

unsafe void	sortChildren ()
	sort recognized children by name Generated from method `MR.Object.sortChildren`.

unsafe bool	select (bool on)
	selects the object, returns true if value changed, otherwise returns false Generated from method `MR.Object.select`.

unsafe void	setAncillary (bool ancillary)
	ancillary object is an object hidden (in scene menu) from a regular user such objects cannot be selected, and if it has been selected, it is unselected when turn ancillary Generated from method `MR.Object.setAncillary`.

unsafe void	setVisible (bool on, MR.Const_ViewportMask? viewportMask=null)
	sets the object visible in the viewports specified by the mask (by default in all viewports) Generated from method `MR.Object.setVisible`. Parameter `viewportMask` defaults to `ViewportMask.all()`.

unsafe void	setVisibilityMask (MR.Const_ViewportMask viewportMask)
	specifies object visibility as bitmask of viewports Generated from method `MR.Object.setVisibilityMask`.

unsafe void	swap (MR.Object other)
	swaps this object with other note: do not swap object signals, so listeners will get notifications from swapped object requires implementation of `swapBase_` and `swapSignals_` (if type has signals) Generated from method `MR.Object.swap`.

unsafe bool	addTag (string tag)
	adds tag to the object's tag storage additionally calls ObjectTagManager.tagAddedSignal NOTE: tags starting with a dot are considered as service ones and might be hidden from UI Generated from method `MR.Object.addTag`.

unsafe bool	removeTag (string tag)
	removes tag from the object's tag storage additionally calls ObjectTagManager.tagRemovedSignal Generated from method `MR.Object.removeTag`.

Static Public Member Functions
static unsafe implicit	operator MR.ObjectChildrenHolder (Object self)

Detailed Description

named object in the data model Generated from class MR.Object. Base classes: Direct: (non-virtual) MR.ObjectChildrenHolder Derived classes: Direct: (non-virtual) MR.SceneRootObject MR.VisualObject Indirect: (non-virtual) MR.AddVisualProperties<MR.FeatureObject, MR.DimensionsVisualizePropertyType.diameter, MR.DimensionsVisualizePropertyType.angle, MR.DimensionsVisualizePropertyType.length> MR.AddVisualProperties<MR.FeatureObject, MR.DimensionsVisualizePropertyType.diameter, MR.DimensionsVisualizePropertyType.length> MR.AddVisualProperties<MR.FeatureObject, MR.DimensionsVisualizePropertyType.diameter> MR.AngleMeasurementObject MR.CircleObject MR.ConeObject MR.CylinderObject MR.DistanceMeasurementObject MR.FeatureObject MR.LineObject MR.MeasurementObject MR.ObjectDistanceMap MR.ObjectGcode MR.ObjectLabel MR.ObjectLines MR.ObjectLinesHolder MR.ObjectMesh MR.ObjectMeshHolder MR.ObjectPoints MR.ObjectPointsHolder MR.ObjectVoxels MR.PlaneObject MR.PointMeasurementObject MR.PointObject MR.RadiusMeasurementObject MR.SphereObject This is the non-const half of the class.

Constructor & Destructor Documentation

◆ Object() [1/2]

unsafe MR.Object.Object ( )

inline

Constructs an empty (default-constructed) instance.

◆ Object() [2/2]

unsafe MR.Object.Object ( MR._ByValue_Object _other )

inline

Generated from constructor MR.Object.Object.

Member Function Documentation

◆ addChild()

unsafe bool MR.Object.addChild	(	MR._ByValueShared_Object	child,
		bool?	recognizedChild = null )

inline

adds given object at the end of children (recognized or not); returns false if it was already child of this, of if given pointer is empty; child object will always report this as parent after the call;

Parameters

recognizedChild if set to false then child object will be excluded from children() and it will be stored by weak_ptr Generated from method MR.Object.addChild. Parameter recognizedChild defaults to true.

◆ addChildBefore()

unsafe bool MR.Object.addChildBefore	(	MR._ByValueShared_Object	newChild,
		MR.Const_Object	existingChild )

inline

adds given object in the recognized children before existingChild; if newChild was already among this children then moves it just before existingChild keeping the order of other children intact; returns false if newChild is nullptr, or existingChild is not a child of this Generated from method MR.Object.addChildBefore.

◆ addTag()

unsafe bool MR.Object.addTag ( string tag )

inline

adds tag to the object's tag storage additionally calls ObjectTagManager.tagAddedSignal NOTE: tags starting with a dot are considered as service ones and might be hidden from UI Generated from method MR.Object.addTag.

◆ applyScale()

unsafe void MR.Object.applyScale ( float scaleFactor )

inline

scale object size (all point positions) Generated from method MR.Object.applyScale.

◆ assign()

unsafe MR.Object MR.Object.assign ( MR._ByValue_Object _other )

inline

Generated from method MR.Object.operator=.

◆ asType()

unsafe new MR.? VisualObject MR.Object.asType ( )

inline

Generated from method MR.Object.asType<MR.VisualObject>.

◆ children()

unsafe new MR.Std.Const_Vector_StdSharedPtrMRObject MR.Object.children ( )

inline

an object can hold other sub-objects Generated from method MR.Object.children.

◆ detachFromParent()

unsafe bool MR.Object.detachFromParent ( )

inline

removes this from its parent children list returns false if it was already orphan Generated from method MR.Object.detachFromParent.

◆ find()

unsafe new MR.Object MR.Object.find ( string name )

inline

Generated from method MR.Object.find.

◆ findCommonAncestor()

unsafe MR.? Object MR.Object.findCommonAncestor ( MR.Object other )

inline

Find a common ancestor between this object and the other one. Returns null on failure (which is impossible if both are children of the scene root). Will return this if other matches this. Generated from method MR.Object.findCommonAncestor.

◆ operator MR.ObjectChildrenHolder()

static unsafe implicit MR.Object.operator MR.ObjectChildrenHolder ( Object self )

inlinestatic

◆ parent()

unsafe new MR.? Object MR.Object.parent ( )

inline

Generated from method MR.Object.parent.

◆ removeAllChildren()

unsafe void MR.Object.removeAllChildren ( )

inline

detaches all recognized children from this, keeping all unrecognized ones Generated from method MR.Object.removeAllChildren.

◆ removeChild() [1/2]

unsafe bool MR.Object.removeChild ( MR.Const_Object child )

inline

returns false if it was not child of this Generated from method MR.Object.removeChild.

◆ removeChild() [2/2]

unsafe bool MR.Object.removeChild ( MR.Object? child )

inline

Generated from method MR.Object.removeChild.

◆ removeTag()

unsafe bool MR.Object.removeTag ( string tag )

inline

removes tag from the object's tag storage additionally calls ObjectTagManager.tagRemovedSignal Generated from method MR.Object.removeTag.

◆ resetXf()

unsafe void MR.Object.resetXf ( MR._InOpt_ViewportId id = default )

inline

forgets specific transform in given viewport (or forgets all specific transforms for {} input) Generated from method MR.Object.resetXf. Parameter id defaults to {}.

◆ select()

unsafe bool MR.Object.select ( bool on )

inline

selects the object, returns true if value changed, otherwise returns false Generated from method MR.Object.select.

◆ setAncillary()

unsafe void MR.Object.setAncillary ( bool ancillary )

inline

ancillary object is an object hidden (in scene menu) from a regular user such objects cannot be selected, and if it has been selected, it is unselected when turn ancillary Generated from method MR.Object.setAncillary.

◆ setGlobalVisibility()

unsafe void MR.Object.setGlobalVisibility	(	bool	on,
		MR.Const_ViewportMask?	viewportMask = null )

inline

if true sets all predecessors visible, otherwise sets this object invisible Generated from method MR.Object.setGlobalVisibility. Parameter viewportMask defaults to ViewportMask.any().

◆ setLocked()

unsafe void MR.Object.setLocked ( bool on )

inline

Generated from method MR.Object.setLocked.

◆ setName()

unsafe void MR.Object.setName ( string name )

inline

Generated from method MR.Object.setName.

◆ setParentLocked()

unsafe void MR.Object.setParentLocked ( bool lock_ )

inline

Generated from method MR.Object.setParentLocked.

◆ setVisibilityMask()

unsafe void MR.Object.setVisibilityMask ( MR.Const_ViewportMask viewportMask )

inline

specifies object visibility as bitmask of viewports Generated from method MR.Object.setVisibilityMask.

◆ setVisible()

unsafe void MR.Object.setVisible	(	bool	on,
		MR.Const_ViewportMask?	viewportMask = null )

inline

sets the object visible in the viewports specified by the mask (by default in all viewports) Generated from method MR.Object.setVisible. Parameter viewportMask defaults to ViewportMask.all().

◆ setWorldXf()

unsafe void MR.Object.setWorldXf	(	in MR.AffineXf3f	xf,
		MR._InOpt_ViewportId	id = default )

inline

Generated from method MR.Object.setWorldXf. Parameter id defaults to {}.

◆ setXf()

unsafe void MR.Object.setXf	(	in MR.AffineXf3f	xf,
		MR._InOpt_ViewportId	id = default )

inline

Generated from method MR.Object.setXf. Parameter id defaults to {}.

◆ setXfsForAllViewports()

unsafe void MR.Object.setXfsForAllViewports ( MR._ByValue_ViewportProperty_MRAffineXf3f xf )

inline

modifies xfs for all viewports at once Generated from method MR.Object.setXfsForAllViewports.

◆ sortChildren()

unsafe void MR.Object.sortChildren ( )

inline

sort recognized children by name Generated from method MR.Object.sortChildren.

◆ swap()

unsafe void MR.Object.swap ( MR.Object other )

inline

swaps this object with other note: do not swap object signals, so listeners will get notifications from swapped object requires implementation of swapBase_ and swapSignals_ (if type has signals) Generated from method MR.Object.swap.

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

MRObject.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Object() [1/2]

◆ Object() [2/2]

Member Function Documentation

◆ addChild()

◆ addChildBefore()

◆ addTag()

◆ applyScale()

◆ assign()

◆ asType()

◆ children()

◆ detachFromParent()

◆ find()

◆ findCommonAncestor()

◆ operator MR.ObjectChildrenHolder()

◆ parent()

◆ removeAllChildren()

◆ removeChild() [1/2]

◆ removeChild() [2/2]

◆ removeTag()

◆ resetXf()

◆ select()

◆ setAncillary()

◆ setGlobalVisibility()

◆ setLocked()

◆ setName()

◆ setParentLocked()

◆ setVisibilityMask()

◆ setVisible()

◆ setWorldXf()

◆ setXf()

◆ setXfsForAllViewports()

◆ sortChildren()

◆ swap()