MR.SceneRootObject Class Reference

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

Inheritance diagram for MR.SceneRootObject:

Public Member Functions
unsafe	SceneRootObject ()
	Constructs an empty (default-constructed) instance.
unsafe	SceneRootObject (MR._ByValue_SceneRootObject _other)
	Generated from constructor MR.SceneRootObject.SceneRootObject.
unsafe MR.SceneRootObject	assign (MR._ByValue_SceneRootObject _other)
	Generated from method MR::SceneRootObject::operator=.
unsafe void	setAncillary (bool _1)
	Generated from method MR.SceneRootObject.setAncillary.
unsafe bool	select (bool _1)
	Generated from method MR.SceneRootObject.select.
unsafe void	setName (string _1)
	Generated from method MR.SceneRootObject.setName.
unsafe void	setXf (in MR.AffineXf3f xf, MR._InOpt_ViewportId id=default)
	Generated from method MR.SceneRootObject.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.SceneRootObject.resetXf. Parameter id defaults to {}.
unsafe void	setXfsForAllViewports (MR._ByValue_ViewportProperty_MRAffineXf3f xf)
	modifies xfs for all viewports at once Generated from method MR.SceneRootObject.setXfsForAllViewports.
unsafe void	setWorldXf (in MR.AffineXf3f xf, MR._InOpt_ViewportId id=default)
	Generated from method MR.SceneRootObject.setWorldXf. Parameter id defaults to {}.
unsafe void	applyScale (float scaleFactor)
	scale object size (all point positions) Generated from method MR.SceneRootObject.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.SceneRootObject.setGlobalVisibility. Parameter viewportMask defaults to ViewportMask.any().
unsafe void	setLocked (bool on)
	Generated from method MR.SceneRootObject.setLocked.
unsafe void	setParentLocked (bool lock_)
	Generated from method MR.SceneRootObject.setParentLocked.
unsafe bool	detachFromParent ()
	removes this from its parent children list returns false if it was already orphan Generated from method MR.SceneRootObject.detachFromParent.
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.SceneRootObject.addChildBefore.
unsafe void	removeAllChildren ()
	detaches all recognized children from this, keeping all unrecognized ones Generated from method MR.SceneRootObject.removeAllChildren.
unsafe void	sortChildren ()
	sort recognized children by name Generated from method MR.SceneRootObject.sortChildren.
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.SceneRootObject.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.SceneRootObject.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.SceneRootObject.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.SceneRootObject.addTag.
unsafe bool	removeTag (string tag)
	removes tag from the object's tag storage additionally calls ObjectTagManager::tagRemovedSignal Generated from method MR.SceneRootObject.removeTag.

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

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

Constructor & Destructor Documentation

SceneRootObject() [1/2]

unsafe MR.SceneRootObject.SceneRootObject ( )

inline

Constructs an empty (default-constructed) instance.

SceneRootObject() [2/2]

unsafe MR.SceneRootObject.SceneRootObject ( MR._ByValue_SceneRootObject _other )

inline

Generated from constructor MR.SceneRootObject.SceneRootObject.

Member Function Documentation

addChild()

unsafe bool MR.SceneRootObject.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.SceneRootObject.addChild. Parameter recognizedChild defaults to true.

addChildBefore()

unsafe bool MR.SceneRootObject.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.SceneRootObject.addChildBefore.

addTag()

unsafe bool MR.SceneRootObject.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.SceneRootObject.addTag.

applyScale()

unsafe void MR.SceneRootObject.applyScale ( float scaleFactor )

inline

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

assign()

unsafe MR.SceneRootObject MR.SceneRootObject.assign ( MR._ByValue_SceneRootObject _other )

inline

Generated from method MR::SceneRootObject::operator=.

detachFromParent()

unsafe bool MR.SceneRootObject.detachFromParent ( )

inline

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

operator MR.Object()

unsafe implicit MR.SceneRootObject.operator MR.Object ( SceneRootObject self )

inlinestatic

operator MR.ObjectChildrenHolder()

unsafe implicit MR.SceneRootObject.operator MR.ObjectChildrenHolder ( SceneRootObject self )

inlinestatic

operator SceneRootObject?()

unsafe MR.SceneRootObject.operator SceneRootObject? ( MR.Object parent )

inlineexplicitstatic

removeAllChildren()

unsafe void MR.SceneRootObject.removeAllChildren ( )

inline

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

removeTag()

unsafe bool MR.SceneRootObject.removeTag ( string tag )

inline

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

resetXf()

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

inline

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

select()

unsafe bool MR.SceneRootObject.select ( bool _1 )

inline

Generated from method MR.SceneRootObject.select.

setAncillary()

unsafe void MR.SceneRootObject.setAncillary ( bool _1 )

inline

Generated from method MR.SceneRootObject.setAncillary.

setGlobalVisibility()

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

inline

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

setLocked()

unsafe void MR.SceneRootObject.setLocked ( bool on )

inline

Generated from method MR.SceneRootObject.setLocked.

setName()

unsafe void MR.SceneRootObject.setName ( string _1 )

inline

Generated from method MR.SceneRootObject.setName.

setParentLocked()

unsafe void MR.SceneRootObject.setParentLocked ( bool lock_ )

inline

Generated from method MR.SceneRootObject.setParentLocked.

setVisibilityMask()

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

inline

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

setVisible()

unsafe void MR.SceneRootObject.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.SceneRootObject.setVisible. Parameter viewportMask defaults to ViewportMask.all().

setWorldXf()

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

inline

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

setXf()

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

inline

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

setXfsForAllViewports()

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

inline

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

sortChildren()

unsafe void MR.SceneRootObject.sortChildren ( )

inline

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

swap()

unsafe void MR.SceneRootObject.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.SceneRootObject.swap.

---

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

• MRSceneRoot.cs