MR.Const_Object Class Reference

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 const half of the class. More...

Inheritance diagram for MR.Const_Object:

Classes
struct	_Underlying
struct	_UnderlyingShared

Public Member Functions
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.Object	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.Object	cloneTree ()
	clones all tree of this object (except ancillary and unrecognized children) Generated from method MR.Object.cloneTree.
unsafe MR.Object	clone ()
	clones current object only, without parent and/or children Generated from method MR.Object.clone.
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.Object.shallowCloneTree.
unsafe MR.Object	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.Object	getSharedPtr ()
	Generated from method MR.Object.getSharedPtr.

Static Public Member Functions
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.

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_Object >
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

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 const half of the class.

Member Function Documentation

worldXf()

unsafe MR.AffineXf3f MR.Const_Object.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.Object.worldXf. Parameter id defaults to {}.

xf()

unsafe ref readonly MR.AffineXf3f MR.Const_Object.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.Object.xf. Parameter id defaults to {}.

---

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

• MRObject.cs