Object that is parent of all scene Generated from class MR.SceneRootObject. Base classes: Direct: (non-virtual) MR.Object Indirect: (non-virtual) MR.ObjectChildrenHolder This is the const half of the class. More...

Inheritance diagram for MR.Const_SceneRootObject:

Classes
struct	_Underlying

Public Member Functions
virtual void	Dispose ()
unsafe	Const_SceneRootObject ()
	Constructs an empty (default-constructed) instance.
unsafe	Const_SceneRootObject (MR._ByValue_SceneRootObject _other)
	Generated from constructor MR.SceneRootObject.SceneRootObject.
unsafe? byte	typeName ()
	Generated from method MR.SceneRootObject.typeName.
unsafe MR.Std.String	className ()
	Generated from method MR.SceneRootObject.className.
unsafe MR.Std.String	classNameInPlural ()
	Generated from method MR.SceneRootObject.classNameInPlural.
unsafe MR.Std.SharedPtr_MRObject	clone ()
	Generated from method MR.SceneRootObject.clone.
unsafe MR.Std.SharedPtr_MRSceneRootObject	cloneRoot ()
	same as clone but returns correct type Generated from method MR.SceneRootObject.cloneRoot.
unsafe MR.Std.Const_String	name ()
	Generated from method MR.SceneRootObject.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.SceneRootObject.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.SceneRootObject.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.SceneRootObject.globalVisibility. Parameter viewportMask defaults to ViewportMask.any().
unsafe bool	isLocked ()
	object properties lock for UI Generated from method MR.SceneRootObject.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.SceneRootObject.isParentLocked.
unsafe bool	isAncestor (MR.Const_Object? ancestor)
	return true if given object is ancestor of this one, false otherwise Generated from method MR.SceneRootObject.isAncestor.
unsafe bool	isSelected ()
	Generated from method MR.SceneRootObject.isSelected.
unsafe bool	isAncillary ()
	Generated from method MR.SceneRootObject.isAncillary.
unsafe bool	isGlobalAncillary ()
	returns true if the object or any of its ancestors are ancillary Generated from method MR.SceneRootObject.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.SceneRootObject.isVisible. Parameter viewportMask defaults to ViewportMask.any().
unsafe MR.ViewportMask	visibilityMask ()
	gets object visibility as bitmask of viewports Generated from method MR.SceneRootObject.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.SceneRootObject.getRedrawFlag.
unsafe void	resetRedrawFlag ()
	Generated from method MR.SceneRootObject.resetRedrawFlag.
unsafe MR.Std.SharedPtr_MRObject	cloneTree ()
	clones all tree of this object (except ancillary and unrecognized children) Generated from method MR.SceneRootObject.cloneTree.
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.SceneRootObject.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.SceneRootObject.shallowClone.
unsafe MR.Std.Vector_StdString	getInfoLines ()
	return several info lines that can better describe object in the UI Generated from method MR.SceneRootObject.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.SceneRootObject.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.SceneRootObject.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.SceneRootObject.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.SceneRootObject.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.SceneRootObject.tags.
unsafe ulong	heapBytes ()
	returns the amount of memory this object occupies on heap Generated from method MR.SceneRootObject.heapBytes.
unsafe bool	sameModels (MR.Const_Object other)
	Generated from method MR.SceneRootObject.sameModels.
unsafe ulong	getModelHash ()
	Generated from method MR.SceneRootObject.getModelHash.
unsafe MR.Std.SharedPtr_MRObject	getSharedPtr ()
	Generated from method MR.SceneRootObject.getSharedPtr.

Static Public Member Functions
static unsafe implicit	operator MR.Const_ObjectChildrenHolder (Const_SceneRootObject self)
static unsafe implicit	operator MR.Const_Object (Const_SceneRootObject self)
static unsafe	operator Const_SceneRootObject? (MR.Const_Object parent)
static unsafe? byte	staticTypeName ()
	Generated from method MR::SceneRootObject::StaticTypeName.
static unsafe? byte	staticClassName ()
	Generated from method MR::SceneRootObject::StaticClassName.
static unsafe? byte	staticClassNameInPlural ()
	Generated from method MR::SceneRootObject::StaticClassNameInPlural.
static unsafe? byte	rootName ()
	Generated from method MR::SceneRootObject::RootName.

Protected Member Functions
virtual unsafe void	Dispose (bool disposing)

Detailed Description

Object that is parent of all scene Generated from class MR.SceneRootObject. Base classes: Direct: (non-virtual) MR.Object Indirect: (non-virtual) MR.ObjectChildrenHolder This is the const half of the class.

Constructor & Destructor Documentation

◆ Const_SceneRootObject() [1/2]

unsafe MR.Const_SceneRootObject.Const_SceneRootObject ( )

inline

Constructs an empty (default-constructed) instance.

◆ Const_SceneRootObject() [2/2]

unsafe MR.Const_SceneRootObject.Const_SceneRootObject ( MR._ByValue_SceneRootObject _other )

inline

Generated from constructor MR.SceneRootObject.SceneRootObject.

Member Function Documentation

◆ className()

unsafe MR.Std.String MR.Const_SceneRootObject.className ( )

inline

Generated from method MR.SceneRootObject.className.

◆ classNameInPlural()

unsafe MR.Std.String MR.Const_SceneRootObject.classNameInPlural ( )

inline

Generated from method MR.SceneRootObject.classNameInPlural.

◆ clone()

unsafe MR.Std.SharedPtr_MRObject MR.Const_SceneRootObject.clone ( )

inline

Generated from method MR.SceneRootObject.clone.

◆ cloneRoot()

unsafe MR.Std.SharedPtr_MRSceneRootObject MR.Const_SceneRootObject.cloneRoot ( )

inline

same as clone but returns correct type Generated from method MR.SceneRootObject.cloneRoot.

◆ cloneTree()

unsafe MR.Std.SharedPtr_MRObject MR.Const_SceneRootObject.cloneTree ( )

inline

clones all tree of this object (except ancillary and unrecognized children) Generated from method MR.SceneRootObject.cloneTree.

◆ Dispose() [1/2]

virtual void MR.Const_SceneRootObject.Dispose ( )

inlinevirtual

◆ Dispose() [2/2]

virtual unsafe void MR.Const_SceneRootObject.Dispose ( bool disposing )

inlineprotectedvirtual

◆ getInfoLines()

unsafe MR.Std.Vector_StdString MR.Const_SceneRootObject.getInfoLines ( )

inline

return several info lines that can better describe object in the UI Generated from method MR.SceneRootObject.getInfoLines.

◆ getModelHash()

unsafe ulong MR.Const_SceneRootObject.getModelHash ( )

inline

Generated from method MR.SceneRootObject.getModelHash.

◆ getRedrawFlag()

unsafe bool MR.Const_SceneRootObject.getRedrawFlag ( MR.Const_ViewportMask _1 )

inline

this method virtual because others data model types could have dirty flags or something Generated from method MR.SceneRootObject.getRedrawFlag.

◆ getSharedPtr()

unsafe MR.Std.SharedPtr_MRObject MR.Const_SceneRootObject.getSharedPtr ( )

inline

Generated from method MR.SceneRootObject.getSharedPtr.

◆ getWorldBox()

unsafe MR.Box3f MR.Const_SceneRootObject.getWorldBox ( MR._InOpt_ViewportId _1 = default )

inline

returns bounding box of this object in world coordinates for default or specific viewport Generated from method MR.SceneRootObject.getWorldBox. Parameter _1 defaults to {}.

◆ getWorldTreeBox()

unsafe MR.Box3f MR.Const_SceneRootObject.getWorldTreeBox ( MR._InOpt_ViewportId _1 = default )

inline

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

◆ globalVisibility()

unsafe bool MR.Const_SceneRootObject.globalVisibility ( MR.Const_ViewportMask? viewportMask = null )

inline

returns true if this object is visible together with all its parents in any of given viewports Generated from method MR.SceneRootObject.globalVisibility. Parameter viewportMask defaults to ViewportMask.any().

◆ globalVisibilityMask()

unsafe MR.ViewportMask MR.Const_SceneRootObject.globalVisibilityMask ( )

inline

returns all viewports where this object is visible together with all its parents Generated from method MR.SceneRootObject.globalVisibilityMask.

◆ hasModel()

unsafe bool MR.Const_SceneRootObject.hasModel ( )

inline

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.SceneRootObject.hasModel.

◆ hasVisualRepresentation()

unsafe bool MR.Const_SceneRootObject.hasVisualRepresentation ( )

inline

does the object have any visual representation (visible points, triangles, edges, etc.), no considering child objects Generated from method MR.SceneRootObject.hasVisualRepresentation.

◆ heapBytes()

unsafe ulong MR.Const_SceneRootObject.heapBytes ( )

inline

returns the amount of memory this object occupies on heap Generated from method MR.SceneRootObject.heapBytes.

◆ isAncestor()

unsafe bool MR.Const_SceneRootObject.isAncestor ( MR.Const_Object? ancestor )

inline

return true if given object is ancestor of this one, false otherwise Generated from method MR.SceneRootObject.isAncestor.

◆ isAncillary()

unsafe bool MR.Const_SceneRootObject.isAncillary ( )

inline

Generated from method MR.SceneRootObject.isAncillary.

◆ isGlobalAncillary()

unsafe bool MR.Const_SceneRootObject.isGlobalAncillary ( )

inline

returns true if the object or any of its ancestors are ancillary Generated from method MR.SceneRootObject.isGlobalAncillary.

◆ isLocked()

unsafe bool MR.Const_SceneRootObject.isLocked ( )

inline

object properties lock for UI Generated from method MR.SceneRootObject.isLocked.

◆ isParentLocked()

unsafe bool MR.Const_SceneRootObject.isParentLocked ( )

inline

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.SceneRootObject.isParentLocked.

◆ isSelected()

unsafe bool MR.Const_SceneRootObject.isSelected ( )

inline

Generated from method MR.SceneRootObject.isSelected.

◆ isVisible()

unsafe bool MR.Const_SceneRootObject.isVisible ( MR.Const_ViewportMask? viewportMask = null )

inline

checks whether the object is visible in any of the viewports specified by the mask (by default in any viewport) Generated from method MR.SceneRootObject.isVisible. Parameter viewportMask defaults to ViewportMask.any().

◆ name()

unsafe MR.Std.Const_String MR.Const_SceneRootObject.name ( )

inline

Generated from method MR.SceneRootObject.name.

◆ operator Const_SceneRootObject?()

unsafe MR.Const_SceneRootObject.operator Const_SceneRootObject? ( MR.Const_Object parent )

inlineexplicitstatic

◆ operator MR.Const_Object()

unsafe implicit MR.Const_SceneRootObject.operator MR.Const_Object ( Const_SceneRootObject self )

inlinestatic

◆ operator MR.Const_ObjectChildrenHolder()

unsafe implicit MR.Const_SceneRootObject.operator MR.Const_ObjectChildrenHolder ( Const_SceneRootObject self )

inlinestatic

◆ resetRedrawFlag()

unsafe void MR.Const_SceneRootObject.resetRedrawFlag ( )

inline

Generated from method MR.SceneRootObject.resetRedrawFlag.

◆ rootName()

unsafe? byte MR.Const_SceneRootObject.rootName ( )

inlinestatic

Generated from method MR::SceneRootObject::RootName.

◆ sameModels()

unsafe bool MR.Const_SceneRootObject.sameModels ( MR.Const_Object other )

inline

Generated from method MR.SceneRootObject.sameModels.

◆ shallowClone()

unsafe MR.Std.SharedPtr_MRObject MR.Const_SceneRootObject.shallowClone ( )

inline

clones current object only, without parent and/or children clones only pointers to mesh, points or voxels Generated from method MR.SceneRootObject.shallowClone.

◆ shallowCloneTree()

unsafe MR.Std.SharedPtr_MRObject MR.Const_SceneRootObject.shallowCloneTree ( )

inline

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

◆ staticClassName()

unsafe? byte MR.Const_SceneRootObject.staticClassName ( )

inlinestatic

Generated from method MR::SceneRootObject::StaticClassName.

◆ staticClassNameInPlural()

unsafe? byte MR.Const_SceneRootObject.staticClassNameInPlural ( )

inlinestatic

Generated from method MR::SceneRootObject::StaticClassNameInPlural.

◆ staticTypeName()

unsafe? byte MR.Const_SceneRootObject.staticTypeName ( )

inlinestatic

Generated from method MR::SceneRootObject::StaticTypeName.

◆ tags()

unsafe MR.Std.Const_Set_StdString MR.Const_SceneRootObject.tags ( )

inline

provides read-only access to the tag storage the storage is a set of unique strings Generated from method MR.SceneRootObject.tags.

◆ typeName()

unsafe? byte MR.Const_SceneRootObject.typeName ( )

inline

Generated from method MR.SceneRootObject.typeName.

◆ visibilityMask()

unsafe MR.ViewportMask MR.Const_SceneRootObject.visibilityMask ( )

inline

gets object visibility as bitmask of viewports Generated from method MR.SceneRootObject.visibilityMask.

◆ worldXf()

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

◆ xf()

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

◆ xfsForAllViewports()

unsafe MR.Const_ViewportProperty_MRAffineXf3f MR.Const_SceneRootObject.xfsForAllViewports ( )

inline

returns xfs for all viewports, combined into a single object Generated from method MR.SceneRootObject.xfsForAllViewports.

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

MRSceneRoot.cs

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Const_SceneRootObject() [1/2]

◆ Const_SceneRootObject() [2/2]

Member Function Documentation

◆ className()

◆ classNameInPlural()

◆ clone()

◆ cloneRoot()

◆ cloneTree()

◆ Dispose() [1/2]

◆ Dispose() [2/2]

◆ getInfoLines()

◆ getModelHash()

◆ getRedrawFlag()

◆ getSharedPtr()

◆ getWorldBox()

◆ getWorldTreeBox()

◆ globalVisibility()

◆ globalVisibilityMask()

◆ hasModel()

◆ hasVisualRepresentation()

◆ heapBytes()

◆ isAncestor()

◆ isAncillary()

◆ isGlobalAncillary()

◆ isLocked()

◆ isParentLocked()

◆ isSelected()

◆ isVisible()

◆ name()

◆ operator Const_SceneRootObject?()

◆ operator MR.Const_Object()

◆ operator MR.Const_ObjectChildrenHolder()

◆ resetRedrawFlag()

◆ rootName()

◆ sameModels()

◆ shallowClone()

◆ shallowCloneTree()

◆ staticClassName()

◆ staticClassNameInPlural()

◆ staticTypeName()

◆ tags()

◆ typeName()

◆ visibilityMask()

◆ worldXf()

◆ xf()

◆ xfsForAllViewports()