MeshLib Java Docs
Loading...
Searching...
No Matches
meshlib.SceneRootObject Class Reference
Inheritance diagram for meshlib.SceneRootObject:

Public Member Functions

 SceneRootObject (java.lang.foreign.MemorySegment ptr, boolean owned, java.lang.Object owner)
 SceneRootObject ()
 SceneRootObject (meshlib.SceneRootObject _other)
meshlib.SceneRootObject assignFromAnother (meshlib.SceneRootObject _other)
java.lang.Byte typeName ()
meshlib.std_string className ()
meshlib.std_string classNameInPlural ()
void setAncillary (boolean _1)
boolean select (boolean _1)
void setName (java.lang.String _1)
meshlib.std_shared_ptr_MR_Object clone_2 ()
meshlib.std_shared_ptr_MR_SceneRootObject cloneRoot ()
meshlib.std_string name ()
meshlib.AffineXf3f xf (meshlib.ViewportId id, meshlib.bool_output isDef)
void setXf (meshlib.AffineXf3f xf, meshlib.ViewportId id)
void resetXf (meshlib.ViewportId id)
meshlib.ViewportProperty_MR_AffineXf3f xfsForAllViewports ()
void setXfsForAllViewports (meshlib.ViewportProperty_MR_AffineXf3f xf)
meshlib.AffineXf3f worldXf (meshlib.ViewportId id, meshlib.bool_output isDef)
void setWorldXf (meshlib.AffineXf3f xf, meshlib.ViewportId id)
void applyScale (float scaleFactor)
meshlib.ViewportMask globalVisibilityMask ()
boolean globalVisibility (meshlib.ViewportMask viewportMask)
void setGlobalVisibility (boolean on, meshlib.ViewportMask viewportMask)
boolean isLocked ()
void setLocked (boolean on)
boolean isParentLocked ()
void setParentLocked (boolean lock)
boolean isAncestor (meshlib.Object ancestor)
boolean detachFromParent ()
meshlib.ConstChildren constChildren ()
boolean addChild (meshlib.std_shared_ptr_MR_Object child, java.lang.Boolean recognizedChild)
boolean addChildBefore (meshlib.std_shared_ptr_MR_Object newChild, meshlib.std_shared_ptr_MR_Object existingChild)
void removeAllChildren ()
void sortChildren ()
boolean isSelected ()
boolean isAncillary ()
boolean isGlobalAncillary ()
void setVisible (boolean on, meshlib.ViewportMask viewportMask)
boolean isVisible (meshlib.ViewportMask viewportMask)
void setVisibilityMask (meshlib.ViewportMask viewportMask)
meshlib.ViewportMask visibilityMask ()
boolean getRedrawFlag (meshlib.ViewportMask _1)
void resetRedrawFlag ()
meshlib.std_shared_ptr_MR_Object cloneTree ()
meshlib.std_shared_ptr_MR_Object shallowCloneTree ()
meshlib.std_shared_ptr_MR_Object shallowClone ()
meshlib.std_vector_std_string getInfoLines ()
void swap (meshlib.Object other)
meshlib.Box3f getWorldBox (meshlib.ViewportId _1)
meshlib.Box3f getWorldTreeBox (meshlib.ViewportId _1)
boolean hasVisualRepresentation ()
boolean hasModel ()
meshlib.std_set_std_string tags ()
boolean addTag (java.lang.String tag)
boolean removeTag (java.lang.String tag)
long heapBytes ()
boolean sameModels (meshlib.Object other)
long getModelHash ()
meshlib.std_shared_ptr_MR_Object getSharedPtr ()
meshlib.ObjectChildrenHolder upcastToObjectChildrenHolder ()
meshlib.Object upcastToObject ()
Public Member Functions inherited from meshlib.CppObject
final java.lang.foreign.MemorySegment rawPointer ()
final boolean isOwned ()
final void close ()
final java.lang.foreign.MemorySegment release ()

Static Public Member Functions

static java.lang.Byte StaticTypeName ()
static java.lang.Byte StaticClassName ()
static java.lang.Byte StaticClassNameInPlural ()
static java.lang.Byte RootName ()
static meshlib.SceneRootObject staticDowncastFromObjectChildrenHolder (meshlib.ObjectChildrenHolder object)
static meshlib.SceneRootObject staticDowncastFromObject (meshlib.Object object)
static meshlib.SceneRootObject dynamicDowncastFromObject (meshlib.Object object)

Additional Inherited Members

Protected Member Functions inherited from meshlib.CppObject
 CppObject (java.lang.foreign.MemorySegment ptr, java.util.function.Consumer< java.lang.foreign.MemorySegment > destroy, java.lang.Object owner)

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

Instances created here own their C++ objects, see CppObject.

Constructor & Destructor Documentation

◆ SceneRootObject() [1/3]

meshlib.SceneRootObject.SceneRootObject ( java.lang.foreign.MemorySegment ptr,
boolean owned,
java.lang.Object owner )

Wraps a pointer from the C bindings. If owned, the object is destroyed when the wrapper dies. owner is kept alive as long as this wrapper is. Not for normal use.

◆ SceneRootObject() [2/3]

meshlib.SceneRootObject.SceneRootObject ( )

Constructs an empty (default-constructed) instance.

Calls MR_SceneRootObject_DefaultConstruct().

◆ SceneRootObject() [3/3]

meshlib.SceneRootObject.SceneRootObject ( meshlib.SceneRootObject _other)

Generated from constructor MR::SceneRootObject::SceneRootObject. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object.

Calls MR_SceneRootObject_ConstructFromAnother().

Member Function Documentation

◆ addChild()

boolean meshlib.SceneRootObject.addChild ( meshlib.std_shared_ptr_MR_Object child,
java.lang.Boolean recognizedChild )

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
recognizedChildif 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.

Calls MR_SceneRootObject_addChild().

◆ addChildBefore()

boolean meshlib.SceneRootObject.addChildBefore ( meshlib.std_shared_ptr_MR_Object newChild,
meshlib.std_shared_ptr_MR_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::SceneRootObject::addChildBefore.

Calls MR_SceneRootObject_addChildBefore().

◆ addTag()

boolean meshlib.SceneRootObject.addTag ( java.lang.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.

Calls MR_SceneRootObject_addTag().

◆ applyScale()

void meshlib.SceneRootObject.applyScale ( float scaleFactor)

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

Calls MR_SceneRootObject_applyScale().

◆ assignFromAnother()

meshlib.SceneRootObject meshlib.SceneRootObject.assignFromAnother ( meshlib.SceneRootObject _other)

Generated from method MR::SceneRootObject::operator=. The reference to things referred to by the parameter _other (if any) might be preserved in this object. The reference to this object might be preserved in the return value.

Calls MR_SceneRootObject_AssignFromAnother().

◆ className()

meshlib.std_string meshlib.SceneRootObject.className ( )

Generated from method MR::SceneRootObject::className.

Calls MR_SceneRootObject_className().

◆ classNameInPlural()

meshlib.std_string meshlib.SceneRootObject.classNameInPlural ( )

Generated from method MR::SceneRootObject::classNameInPlural.

Calls MR_SceneRootObject_classNameInPlural().

◆ clone_2()

meshlib.std_shared_ptr_MR_Object meshlib.SceneRootObject.clone_2 ( )

Generated from method MR::SceneRootObject::clone.

Calls MR_SceneRootObject_clone().

◆ cloneRoot()

meshlib.std_shared_ptr_MR_SceneRootObject meshlib.SceneRootObject.cloneRoot ( )

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

Calls MR_SceneRootObject_cloneRoot().

◆ cloneTree()

meshlib.std_shared_ptr_MR_Object meshlib.SceneRootObject.cloneTree ( )

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

Calls MR_SceneRootObject_cloneTree().

◆ constChildren()

meshlib.ConstChildren meshlib.SceneRootObject.constChildren ( )

the same sub-objects without the ability to modify them; the returned view is invalidated by anything that changes the children of this object Generated from method MR::SceneRootObject::constChildren.

Calls MR_SceneRootObject_constChildren().

◆ detachFromParent()

boolean meshlib.SceneRootObject.detachFromParent ( )

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

Calls MR_SceneRootObject_detachFromParent().

◆ dynamicDowncastFromObject()

meshlib.SceneRootObject meshlib.SceneRootObject.dynamicDowncastFromObject ( meshlib.Object object)
static

Dynamic downcast from the base class MR::Object. Returns null if the object isn't actually a SceneRootObject. The result refers to object.

Calls MR_SceneRootObject_MutableDynamicDowncastFrom_MR_Object().

◆ getInfoLines()

meshlib.std_vector_std_string meshlib.SceneRootObject.getInfoLines ( )

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

Calls MR_SceneRootObject_getInfoLines().

◆ getModelHash()

long meshlib.SceneRootObject.getModelHash ( )

return hash of model (or hash object pointer if object has no model) Generated from method MR::SceneRootObject::getModelHash.

Calls MR_SceneRootObject_getModelHash().

◆ getRedrawFlag()

boolean meshlib.SceneRootObject.getRedrawFlag ( meshlib.ViewportMask _1)

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

Calls MR_SceneRootObject_getRedrawFlag().

◆ getSharedPtr()

meshlib.std_shared_ptr_MR_Object meshlib.SceneRootObject.getSharedPtr ( )

returns this Object as shared_ptr finds it among its parent's recognized children Generated from method MR::SceneRootObject::getSharedPtr.

Calls MR_SceneRootObject_getSharedPtr().

◆ getWorldBox()

meshlib.Box3f meshlib.SceneRootObject.getWorldBox ( meshlib.ViewportId _1)

returns bounding box of this object in world coordinates for default or specific viewport Generated from method MR::SceneRootObject::getWorldBox.

Calls MR_SceneRootObject_getWorldBox().

◆ getWorldTreeBox()

meshlib.Box3f meshlib.SceneRootObject.getWorldTreeBox ( meshlib.ViewportId _1)

returns bounding box of this object and all children visible in given (or default) viewport in world coordinates Generated from method MR::SceneRootObject::getWorldTreeBox.

Calls MR_SceneRootObject_getWorldTreeBox().

◆ globalVisibility()

boolean meshlib.SceneRootObject.globalVisibility ( meshlib.ViewportMask viewportMask)

returns true if this object is visible together with all its parents in any of given viewports Generated from method MR::SceneRootObject::globalVisibility.

Calls MR_SceneRootObject_globalVisibility().

◆ globalVisibilityMask()

meshlib.ViewportMask meshlib.SceneRootObject.globalVisibilityMask ( )

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

Calls MR_SceneRootObject_globalVisibilityMask().

◆ hasModel()

boolean meshlib.SceneRootObject.hasModel ( )

does the object have any model available (but possibly empty), e.g. ObjectMesh has valid meshPtr() or ObjectPoints has valid pointCloudPtr() Generated from method MR::SceneRootObject::hasModel.

Calls MR_SceneRootObject_hasModel().

◆ hasVisualRepresentation()

boolean meshlib.SceneRootObject.hasVisualRepresentation ( )

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

Calls MR_SceneRootObject_hasVisualRepresentation().

◆ heapBytes()

long meshlib.SceneRootObject.heapBytes ( )

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

Calls MR_SceneRootObject_heapBytes().

◆ isAncestor()

boolean meshlib.SceneRootObject.isAncestor ( meshlib.Object ancestor)

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

Calls MR_SceneRootObject_isAncestor().

◆ isAncillary()

boolean meshlib.SceneRootObject.isAncillary ( )

Generated from method MR::SceneRootObject::isAncillary.

Calls MR_SceneRootObject_isAncillary().

◆ isGlobalAncillary()

boolean meshlib.SceneRootObject.isGlobalAncillary ( )

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

Calls MR_SceneRootObject_isGlobalAncillary().

◆ isLocked()

boolean meshlib.SceneRootObject.isLocked ( )

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

Calls MR_SceneRootObject_isLocked().

◆ isParentLocked()

boolean meshlib.SceneRootObject.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.

Calls MR_SceneRootObject_isParentLocked().

◆ isSelected()

boolean meshlib.SceneRootObject.isSelected ( )

Generated from method MR::SceneRootObject::isSelected.

Calls MR_SceneRootObject_isSelected().

◆ isVisible()

boolean meshlib.SceneRootObject.isVisible ( meshlib.ViewportMask viewportMask)

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.

Calls MR_SceneRootObject_isVisible().

◆ name()

meshlib.std_string meshlib.SceneRootObject.name ( )

Generated from method MR::SceneRootObject::name.

Calls MR_SceneRootObject_name().

◆ removeAllChildren()

void meshlib.SceneRootObject.removeAllChildren ( )

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

Calls MR_SceneRootObject_removeAllChildren().

◆ removeTag()

boolean meshlib.SceneRootObject.removeTag ( java.lang.String tag)

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

Calls MR_SceneRootObject_removeTag().

◆ resetRedrawFlag()

void meshlib.SceneRootObject.resetRedrawFlag ( )

Generated from method MR::SceneRootObject::resetRedrawFlag.

Calls MR_SceneRootObject_resetRedrawFlag().

◆ resetXf()

void meshlib.SceneRootObject.resetXf ( meshlib.ViewportId id)

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

Calls MR_SceneRootObject_resetXf().

◆ RootName()

java.lang.Byte meshlib.SceneRootObject.RootName ( )
static

Generated from method MR::SceneRootObject::RootName.

Calls MR_SceneRootObject_RootName().

◆ sameModels()

boolean meshlib.SceneRootObject.sameModels ( meshlib.Object other)

return true if model of current object equals to model (the same) of other Generated from method MR::SceneRootObject::sameModels.

Calls MR_SceneRootObject_sameModels().

◆ select()

boolean meshlib.SceneRootObject.select ( boolean _1)

Generated from method MR::SceneRootObject::select.

Calls MR_SceneRootObject_select().

◆ setAncillary()

void meshlib.SceneRootObject.setAncillary ( boolean _1)

Generated from method MR::SceneRootObject::setAncillary.

Calls MR_SceneRootObject_setAncillary().

◆ setGlobalVisibility()

void meshlib.SceneRootObject.setGlobalVisibility ( boolean on,
meshlib.ViewportMask viewportMask )

if true sets all predecessors visible, otherwise sets this object invisible Generated from method MR::SceneRootObject::setGlobalVisibility.

Calls MR_SceneRootObject_setGlobalVisibility().

◆ setLocked()

void meshlib.SceneRootObject.setLocked ( boolean on)

Generated from method MR::SceneRootObject::setLocked.

Calls MR_SceneRootObject_setLocked().

◆ setName()

void meshlib.SceneRootObject.setName ( java.lang.String _1)

Generated from method MR::SceneRootObject::setName.

Calls MR_SceneRootObject_setName().

◆ setParentLocked()

void meshlib.SceneRootObject.setParentLocked ( boolean lock)

Generated from method MR::SceneRootObject::setParentLocked.

Calls MR_SceneRootObject_setParentLocked().

◆ setVisibilityMask()

void meshlib.SceneRootObject.setVisibilityMask ( meshlib.ViewportMask viewportMask)

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

Calls MR_SceneRootObject_setVisibilityMask().

◆ setVisible()

void meshlib.SceneRootObject.setVisible ( boolean on,
meshlib.ViewportMask viewportMask )

sets the object visible in the viewports specified by the mask (by default in all viewports) Generated from method MR::SceneRootObject::setVisible.

Calls MR_SceneRootObject_setVisible().

◆ setWorldXf()

void meshlib.SceneRootObject.setWorldXf ( meshlib.AffineXf3f xf,
meshlib.ViewportId id )

Generated from method MR::SceneRootObject::setWorldXf.

Calls MR_SceneRootObject_setWorldXf().

◆ setXf()

void meshlib.SceneRootObject.setXf ( meshlib.AffineXf3f xf,
meshlib.ViewportId id )

Generated from method MR::SceneRootObject::setXf.

Calls MR_SceneRootObject_setXf().

◆ setXfsForAllViewports()

void meshlib.SceneRootObject.setXfsForAllViewports ( meshlib.ViewportProperty_MR_AffineXf3f xf)

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

Calls MR_SceneRootObject_setXfsForAllViewports().

◆ shallowClone()

meshlib.std_shared_ptr_MR_Object meshlib.SceneRootObject.shallowClone ( )

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

Calls MR_SceneRootObject_shallowClone().

◆ shallowCloneTree()

meshlib.std_shared_ptr_MR_Object meshlib.SceneRootObject.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.

Calls MR_SceneRootObject_shallowCloneTree().

◆ sortChildren()

void meshlib.SceneRootObject.sortChildren ( )

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

Calls MR_SceneRootObject_sortChildren().

◆ StaticClassName()

java.lang.Byte meshlib.SceneRootObject.StaticClassName ( )
static

Generated from method MR::SceneRootObject::StaticClassName.

Calls MR_SceneRootObject_StaticClassName().

◆ StaticClassNameInPlural()

java.lang.Byte meshlib.SceneRootObject.StaticClassNameInPlural ( )
static

Generated from method MR::SceneRootObject::StaticClassNameInPlural.

Calls MR_SceneRootObject_StaticClassNameInPlural().

◆ staticDowncastFromObject()

meshlib.SceneRootObject meshlib.SceneRootObject.staticDowncastFromObject ( meshlib.Object object)
static

Static downcast from the base class MR::Object. Undefined behavior if the object isn't actually a SceneRootObject. The result refers to object.

Calls MR_SceneRootObject_MutableStaticDowncastFrom_MR_Object().

◆ staticDowncastFromObjectChildrenHolder()

meshlib.SceneRootObject meshlib.SceneRootObject.staticDowncastFromObjectChildrenHolder ( meshlib.ObjectChildrenHolder object)
static

Static downcast from the base class MR::ObjectChildrenHolder. Undefined behavior if the object isn't actually a SceneRootObject. The result refers to object.

Calls MR_SceneRootObject_MutableStaticDowncastFrom_MR_ObjectChildrenHolder().

◆ StaticTypeName()

java.lang.Byte meshlib.SceneRootObject.StaticTypeName ( )
static

Generated from method MR::SceneRootObject::StaticTypeName.

Calls MR_SceneRootObject_StaticTypeName().

◆ swap()

void meshlib.SceneRootObject.swap ( meshlib.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.

Calls MR_SceneRootObject_swap().

◆ tags()

meshlib.std_set_std_string meshlib.SceneRootObject.tags ( )

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

Calls MR_SceneRootObject_tags().

◆ typeName()

java.lang.Byte meshlib.SceneRootObject.typeName ( )

Generated from method MR::SceneRootObject::typeName.

Calls MR_SceneRootObject_typeName().

◆ upcastToObject()

meshlib.Object meshlib.SceneRootObject.upcastToObject ( )

Upcasts to the base class MR::Object. The result refers to this object.

Calls MR_SceneRootObject_MutableUpcastTo_MR_Object().

◆ upcastToObjectChildrenHolder()

meshlib.ObjectChildrenHolder meshlib.SceneRootObject.upcastToObjectChildrenHolder ( )

Upcasts to the base class MR::ObjectChildrenHolder. The result refers to this object.

Calls MR_SceneRootObject_MutableUpcastTo_MR_ObjectChildrenHolder().

◆ visibilityMask()

meshlib.ViewportMask meshlib.SceneRootObject.visibilityMask ( )

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

Calls MR_SceneRootObject_visibilityMask().

◆ worldXf()

meshlib.AffineXf3f meshlib.SceneRootObject.worldXf ( meshlib.ViewportId id,
meshlib.bool_output isDef )

this space to world space transformation for default or specific viewport

Parameters
isDefreceives true if the object has default transformation in this viewport (same as worldXf() returns) Generated from method MR::SceneRootObject::worldXf.

Calls MR_SceneRootObject_worldXf().

◆ xf()

meshlib.AffineXf3f meshlib.SceneRootObject.xf ( meshlib.ViewportId id,
meshlib.bool_output isDef )

this space to parent space transformation (to world space if no parent) for default or given viewport

Parameters
isDefreceives true if the object has default transformation in this viewport (same as xf() returns) Generated from method MR::SceneRootObject::xf.

Calls MR_SceneRootObject_xf().

◆ xfsForAllViewports()

meshlib.ViewportProperty_MR_AffineXf3f meshlib.SceneRootObject.xfsForAllViewports ( )

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

Calls MR_SceneRootObject_xfsForAllViewports().


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