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.Std.SharedPtr_MRObject	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.Std._ByValue_SharedPtr_MRObject 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.Std._ByValue_SharedPtr_MRObject newChild, MR.Std.Const_SharedPtr_MRObject 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.Std.Const_SharedPtr_MRObject 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.
Public Member Functions inherited from MR.Const_Object
virtual void	Dispose ()
unsafe	Const_Object ()
	Constructs an empty (default-constructed) instance.
unsafe	Const_Object (MR._ByValue_Object _other)
	Generated from constructor MR.Object.Object.
unsafe? byte	typeName ()
	Generated from method MR.Object.typeName.
unsafe MR.Std.String	className ()
	Generated from method MR.Object.className.
unsafe MR.Std.String	classNameInPlural ()
	Generated from method MR.Object.classNameInPlural.
unsafe MR.? Const_VisualObject	asType ()
	Generated from method MR.Object.asType<MR.VisualObject>.
unsafe MR.Std.Const_String	name ()
	Generated from method MR.Object.name.
unsafe MR.Std.SharedPtr_ConstMRObject	find (string name)
	finds a direct child by name Generated from method MR.Object.find.
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.Object.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.Object.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.Object.globalVisibility. Parameter viewportMask defaults to ViewportMask.any().
unsafe bool	isLocked ()
	object properties lock for UI Generated from method MR.Object.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.Object.isParentLocked.
unsafe MR.? Const_Object	parent ()
	returns parent object in the tree Generated from method MR.Object.parent.
unsafe bool	isAncestor (MR.Const_Object? ancestor)
	return true if given object is ancestor of this one, false otherwise Generated from method MR.Object.isAncestor.
unsafe MR.? Const_Object	findCommonAncestor (MR.Const_Object other)
	Generated from method MR.Object.findCommonAncestor.
unsafe MR.Std.Const_Vector_StdSharedPtrConstMRObject	children ()
	Generated from method MR.Object.children.
unsafe bool	isSelected ()
	Generated from method MR.Object.isSelected.
unsafe bool	isAncillary ()
	Generated from method MR.Object.isAncillary.
unsafe bool	isGlobalAncillary ()
	returns true if the object or any of its ancestors are ancillary Generated from method MR.Object.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.Object.isVisible. Parameter viewportMask defaults to ViewportMask.any().
unsafe MR.ViewportMask	visibilityMask ()
	gets object visibility as bitmask of viewports Generated from method MR.Object.visibilityMask.
unsafe bool	getRedrawFlag (MR.Const_ViewportMask _1)
	this method virtual because others data model types could have dirty flags or something Generated from method MR.Object.getRedrawFlag.
unsafe void	resetRedrawFlag ()
	Generated from method MR.Object.resetRedrawFlag.
unsafe MR.Std.SharedPtr_MRObject	cloneTree ()
	clones all tree of this object (except ancillary and unrecognized children) Generated from method MR.Object.cloneTree.
unsafe MR.Std.SharedPtr_MRObject	clone ()
	clones current object only, without parent and/or children Generated from method MR.Object.clone.
unsafe MR.Std.SharedPtr_MRObject	shallowCloneTree ()
	clones all tree of this object (except ancillary and unrecognied children) clones only pointers to mesh, points or voxels Generated from method MR.Object.shallowCloneTree.
unsafe MR.Std.SharedPtr_MRObject	shallowClone ()
	clones current object only, without parent and/or children clones only pointers to mesh, points or voxels Generated from method MR.Object.shallowClone.
unsafe MR.Std.Vector_StdString	getInfoLines ()
	return several info lines that can better describe object in the UI Generated from method MR.Object.getInfoLines.
unsafe MR.Box3f	getWorldBox (MR._InOpt_ViewportId _1=default)
	returns bounding box of this object in world coordinates for default or specific viewport Generated from method MR.Object.getWorldBox. Parameter _1 defaults to {}.
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.Object.getWorldTreeBox. Parameter _1 defaults to {}.
unsafe bool	hasVisualRepresentation ()
	does the object have any visual representation (visible points, triangles, edges, etc.), no considering child objects Generated from method MR.Object.hasVisualRepresentation.
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.Object.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.Object.tags.
unsafe ulong	heapBytes ()
	returns the amount of memory this object occupies on heap Generated from method MR.Object.heapBytes.
unsafe bool	sameModels (MR.Const_Object other)
	Generated from method MR.Object.sameModels.
unsafe ulong	getModelHash ()
	Generated from method MR.Object.getModelHash.
unsafe MR.Std.SharedPtr_MRObject	getSharedPtr ()
	Generated from method MR.Object.getSharedPtr.

Static Public Member Functions
static unsafe implicit	operator MR.ObjectChildrenHolder (Object self)
Static Public Member Functions inherited from MR.Const_Object
static unsafe implicit	operator MR.Const_ObjectChildrenHolder (Const_Object self)
static unsafe? byte	staticTypeName ()
	Generated from method MR::Object::StaticTypeName.
static unsafe? byte	staticClassName ()
	return human readable name of subclass Generated from method MR::Object::StaticClassName.
static unsafe? byte	staticClassNameInPlural ()
	return human readable name of subclass in plural form Generated from method MR::Object::StaticClassNameInPlural.

Additional Inherited Members
Protected Member Functions inherited from MR.Const_Object
virtual unsafe void	Dispose (bool disposing)

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.Std._ByValue_SharedPtr_MRObject	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.Std._ByValue_SharedPtr_MRObject	newChild,
		MR.Std.Const_SharedPtr_MRObject	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.Std.SharedPtr_MRObject 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()

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.Object? child )

inline

Generated from method MR.Object.removeChild.

◆ removeChild() [2/2]

unsafe bool MR.Object.removeChild ( MR.Std.Const_SharedPtr_MRObject child )

inline

returns false if it was not child of this 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

Additional Inherited Members

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()