MeshLib Java Docs
Loading...
Searching...
No Matches
Inheritance diagram for meshlib.Object:

Public Member Functions

 Object (java.lang.foreign.MemorySegment ptr, boolean owned, java.lang.Object owner)
 Object ()
 Object (meshlib.Object _other)
meshlib.Object assignFromAnother (meshlib.Object _other)
java.lang.Byte typeName ()
meshlib.std_string className ()
meshlib.std_string classNameInPlural ()
meshlib.VisualObject asType_mut ()
meshlib.VisualObject asType ()
meshlib.std_string name ()
void setName (java.lang.String name)
meshlib.std_shared_ptr_const_MR_Object find (java.lang.String name)
meshlib.std_shared_ptr_MR_Object find_mut (java.lang.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)
meshlib.Object parent ()
meshlib.Object parent_mut ()
boolean isAncestor (meshlib.Object ancestor)
meshlib.Object findCommonAncestor_mut (meshlib.Object other)
meshlib.Object findCommonAncestor (meshlib.Object other)
boolean detachFromParent ()
meshlib.std_vector_std_shared_ptr_MR_Object children_mut ()
meshlib.ConstChildren constChildren ()
meshlib.std_vector_std_shared_ptr_const_MR_Object children ()
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)
boolean removeChild (meshlib.std_shared_ptr_MR_Object child)
boolean removeChild (meshlib.Object child)
void removeAllChildren ()
void sortChildren ()
boolean select (boolean on)
boolean isSelected ()
void setAncillary (boolean ancillary)
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 clone_2 ()
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 ()
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 meshlib.Object staticDowncastFromObjectChildrenHolder (meshlib.ObjectChildrenHolder 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

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

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

Constructor & Destructor Documentation

◆ Object() [1/3]

meshlib.Object.Object ( 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.

◆ Object() [2/3]

meshlib.Object.Object ( )

Constructs an empty (default-constructed) instance.

Calls MR_Object_DefaultConstruct().

◆ Object() [3/3]

meshlib.Object.Object ( meshlib.Object _other)

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

Calls MR_Object_ConstructFromAnother().

Member Function Documentation

◆ addChild()

boolean meshlib.Object.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::Object::addChild.

Calls MR_Object_addChild().

◆ addChildBefore()

boolean meshlib.Object.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::Object::addChildBefore.

Calls MR_Object_addChildBefore().

◆ addTag()

boolean meshlib.Object.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::Object::addTag.

Calls MR_Object_addTag().

◆ applyScale()

void meshlib.Object.applyScale ( float scaleFactor)

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

Calls MR_Object_applyScale().

◆ assignFromAnother()

meshlib.Object meshlib.Object.assignFromAnother ( meshlib.Object _other)

Generated from method MR::Object::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_Object_AssignFromAnother().

◆ asType()

meshlib.VisualObject meshlib.Object.asType ( )

Generated from method MR::Object::asType<MR::VisualObject>.

Calls MR_Object_asType().

◆ asType_mut()

meshlib.VisualObject meshlib.Object.asType_mut ( )

Generated from method MR::Object::asType<MR::VisualObject>.

Calls MR_Object_asType_mut().

◆ children()

Deprecated
the cast inside is undefined behaviour, use constChildren() instead Generated from method MR::Object::children.

Calls MR_Object_children().

◆ children_mut()

meshlib.std_vector_std_shared_ptr_MR_Object meshlib.Object.children_mut ( )

an object can hold other sub-objects Generated from method MR::Object::children.

Calls MR_Object_children_mut().

◆ className()

meshlib.std_string meshlib.Object.className ( )

Generated from method MR::Object::className.

Calls MR_Object_className().

◆ classNameInPlural()

meshlib.std_string meshlib.Object.classNameInPlural ( )

Generated from method MR::Object::classNameInPlural.

Calls MR_Object_classNameInPlural().

◆ clone_2()

meshlib.std_shared_ptr_MR_Object meshlib.Object.clone_2 ( )

clones current object only, without parent and/or children Generated from method MR::Object::clone.

Calls MR_Object_clone().

◆ cloneTree()

meshlib.std_shared_ptr_MR_Object meshlib.Object.cloneTree ( )

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

Calls MR_Object_cloneTree().

◆ constChildren()

meshlib.ConstChildren meshlib.Object.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::Object::constChildren.

Calls MR_Object_constChildren().

◆ detachFromParent()

boolean meshlib.Object.detachFromParent ( )

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

Calls MR_Object_detachFromParent().

◆ find()

meshlib.std_shared_ptr_const_MR_Object meshlib.Object.find ( java.lang.String name)

finds a direct child by name Generated from method MR::Object::find.

Calls MR_Object_find().

◆ find_mut()

meshlib.std_shared_ptr_MR_Object meshlib.Object.find_mut ( java.lang.String name)

Generated from method MR::Object::find.

Calls MR_Object_find_mut().

◆ findCommonAncestor()

meshlib.Object meshlib.Object.findCommonAncestor ( meshlib.Object other)

Generated from method MR::Object::findCommonAncestor.

Calls MR_Object_findCommonAncestor().

◆ findCommonAncestor_mut()

meshlib.Object meshlib.Object.findCommonAncestor_mut ( meshlib.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.

Calls MR_Object_findCommonAncestor_mut().

◆ getInfoLines()

meshlib.std_vector_std_string meshlib.Object.getInfoLines ( )

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

Calls MR_Object_getInfoLines().

◆ getModelHash()

long meshlib.Object.getModelHash ( )

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

Calls MR_Object_getModelHash().

◆ getRedrawFlag()

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

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

Calls MR_Object_getRedrawFlag().

◆ getSharedPtr()

meshlib.std_shared_ptr_MR_Object meshlib.Object.getSharedPtr ( )

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

Calls MR_Object_getSharedPtr().

◆ getWorldBox()

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

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

Calls MR_Object_getWorldBox().

◆ getWorldTreeBox()

meshlib.Box3f meshlib.Object.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::Object::getWorldTreeBox.

Calls MR_Object_getWorldTreeBox().

◆ globalVisibility()

boolean meshlib.Object.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::Object::globalVisibility.

Calls MR_Object_globalVisibility().

◆ globalVisibilityMask()

meshlib.ViewportMask meshlib.Object.globalVisibilityMask ( )

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

Calls MR_Object_globalVisibilityMask().

◆ hasModel()

boolean meshlib.Object.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::Object::hasModel.

Calls MR_Object_hasModel().

◆ hasVisualRepresentation()

boolean meshlib.Object.hasVisualRepresentation ( )

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

Calls MR_Object_hasVisualRepresentation().

◆ heapBytes()

long meshlib.Object.heapBytes ( )

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

Calls MR_Object_heapBytes().

◆ isAncestor()

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

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

Calls MR_Object_isAncestor().

◆ isAncillary()

boolean meshlib.Object.isAncillary ( )

Generated from method MR::Object::isAncillary.

Calls MR_Object_isAncillary().

◆ isGlobalAncillary()

boolean meshlib.Object.isGlobalAncillary ( )

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

Calls MR_Object_isGlobalAncillary().

◆ isLocked()

boolean meshlib.Object.isLocked ( )

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

Calls MR_Object_isLocked().

◆ isParentLocked()

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

Calls MR_Object_isParentLocked().

◆ isSelected()

boolean meshlib.Object.isSelected ( )

Generated from method MR::Object::isSelected.

Calls MR_Object_isSelected().

◆ isVisible()

boolean meshlib.Object.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::Object::isVisible.

Calls MR_Object_isVisible().

◆ name()

meshlib.std_string meshlib.Object.name ( )

Generated from method MR::Object::name.

Calls MR_Object_name().

◆ parent()

meshlib.Object meshlib.Object.parent ( )

returns parent object in the tree Generated from method MR::Object::parent.

Calls MR_Object_parent().

◆ parent_mut()

meshlib.Object meshlib.Object.parent_mut ( )

Generated from method MR::Object::parent.

Calls MR_Object_parent_mut().

◆ removeAllChildren()

void meshlib.Object.removeAllChildren ( )

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

Calls MR_Object_removeAllChildren().

◆ removeChild() [1/2]

boolean meshlib.Object.removeChild ( meshlib.Object child)

Generated from method MR::Object::removeChild.

Calls MR_Object_removeChild_MR_Object_ptr().

◆ removeChild() [2/2]

boolean meshlib.Object.removeChild ( meshlib.std_shared_ptr_MR_Object child)

returns false if it was not child of this Generated from method MR::Object::removeChild.

Calls MR_Object_removeChild_std_shared_ptr_MR_Object().

◆ removeTag()

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

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

Calls MR_Object_removeTag().

◆ resetRedrawFlag()

void meshlib.Object.resetRedrawFlag ( )

Generated from method MR::Object::resetRedrawFlag.

Calls MR_Object_resetRedrawFlag().

◆ resetXf()

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

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

Calls MR_Object_resetXf().

◆ sameModels()

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

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

Calls MR_Object_sameModels().

◆ select()

boolean meshlib.Object.select ( boolean on)

selects the object, returns true if value changed, otherwise returns false Generated from method MR::Object::select.

Calls MR_Object_select().

◆ setAncillary()

void meshlib.Object.setAncillary ( boolean 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.

Calls MR_Object_setAncillary().

◆ setGlobalVisibility()

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

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

Calls MR_Object_setGlobalVisibility().

◆ setLocked()

void meshlib.Object.setLocked ( boolean on)

Generated from method MR::Object::setLocked.

Calls MR_Object_setLocked().

◆ setName()

void meshlib.Object.setName ( java.lang.String name)

Generated from method MR::Object::setName.

Calls MR_Object_setName().

◆ setParentLocked()

void meshlib.Object.setParentLocked ( boolean lock)

Generated from method MR::Object::setParentLocked.

Calls MR_Object_setParentLocked().

◆ setVisibilityMask()

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

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

Calls MR_Object_setVisibilityMask().

◆ setVisible()

void meshlib.Object.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::Object::setVisible.

Calls MR_Object_setVisible().

◆ setWorldXf()

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

Generated from method MR::Object::setWorldXf.

Calls MR_Object_setWorldXf().

◆ setXf()

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

Generated from method MR::Object::setXf.

Calls MR_Object_setXf().

◆ setXfsForAllViewports()

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

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

Calls MR_Object_setXfsForAllViewports().

◆ shallowClone()

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

Calls MR_Object_shallowClone().

◆ shallowCloneTree()

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

Calls MR_Object_shallowCloneTree().

◆ sortChildren()

void meshlib.Object.sortChildren ( )

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

Calls MR_Object_sortChildren().

◆ StaticClassName()

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

return human readable name of subclass Generated from method MR::Object::StaticClassName.

Calls MR_Object_StaticClassName().

◆ StaticClassNameInPlural()

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

return human readable name of subclass in plural form Generated from method MR::Object::StaticClassNameInPlural.

Calls MR_Object_StaticClassNameInPlural().

◆ staticDowncastFromObjectChildrenHolder()

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

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

Calls MR_Object_MutableStaticDowncastFrom_MR_ObjectChildrenHolder().

◆ StaticTypeName()

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

return name of subtype for serialization purposes Generated from method MR::Object::StaticTypeName.

Calls MR_Object_StaticTypeName().

◆ swap()

void meshlib.Object.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::Object::swap.

Calls MR_Object_swap().

◆ tags()

meshlib.std_set_std_string meshlib.Object.tags ( )

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

Calls MR_Object_tags().

◆ typeName()

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

Generated from method MR::Object::typeName.

Calls MR_Object_typeName().

◆ upcastToObjectChildrenHolder()

meshlib.ObjectChildrenHolder meshlib.Object.upcastToObjectChildrenHolder ( )

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

Calls MR_Object_MutableUpcastTo_MR_ObjectChildrenHolder().

◆ visibilityMask()

meshlib.ViewportMask meshlib.Object.visibilityMask ( )

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

Calls MR_Object_visibilityMask().

◆ worldXf()

meshlib.AffineXf3f meshlib.Object.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::Object::worldXf.

Calls MR_Object_worldXf().

◆ xf()

meshlib.AffineXf3f meshlib.Object.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::Object::xf.

Calls MR_Object_xf().

◆ xfsForAllViewports()

meshlib.ViewportProperty_MR_AffineXf3f meshlib.Object.xfsForAllViewports ( )

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

Calls MR_Object_xfsForAllViewports().


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