MeshLib Python Docs
Loading...
Searching...
No Matches
mrmeshpy.ConstLineObject Class Reference
Inheritance diagram for mrmeshpy.ConstLineObject:

Public Member Functions

 __init__ (self, *args, **kwargs)
str className (self)
str classNameInPlural (self)
Object clone (self)
Const_std_vector_FeatureObjectSharedProperty getAllSharedProperties (self)
Vector3f getBasePoint (self, ConstViewportId id=...)
Vector3f getCenter (self, ConstViewportId id=...)
Vector3f getDirection (self, ConstViewportId id=...)
float getLength (self, ConstViewportId id=...)
Vector3f getPointA (self, ConstViewportId id=...)
Vector3f getPointB (self, ConstViewportId id=...)
FeatureObjectProjectPointResult projectPoint (self, ConstVector3f point, ConstViewportId id=...)
Object shallowClone (self)
str typeName (self)
Public Member Functions inherited from mrmeshpy.ConstFeatureObject
std_vector_ViewportMask getAllVisualizeProperties (self)
ConstColor getDecorationsColor (self, bool selected, ConstViewportId viewportId=..., bool_output isDef=None)
ConstViewportProperty_Color getDecorationsColorForAllViewports (self, bool selected)
float getLineWidth (self)
float getMainFeatureAlpha (self)
Vector3f getNormal (self, ConstVector3f point)
float getPointSize (self)
Matrix3f getRotationMatrix (self, ConstViewportId id=..., bool_output isDef=None)
Matrix3f getScaleShearMatrix (self, ConstViewportId id=..., bool_output isDef=None)
float getSubfeatureAlphaLines (self)
float getSubfeatureAlphaMesh (self)
float getSubfeatureAlphaPoints (self)
float getSubfeatureLineWidth (self)
float getSubfeaturePointSize (self)
ConstViewportMask getVisualizePropertyMask (self, ConstAnyVisualizeMaskEnum type)
bool supportsVisualizeProperty (self, ConstAnyVisualizeMaskEnum type)
Public Member Functions inherited from mrmeshpy.ConstVisualObject
 __init__ (self, *args, **kwargs)
float getAmbientStrength (self)
ConstColor getBackColor (self, ConstViewportId viewportId=...)
ConstViewportProperty_Color getBackColorsForAllViewports (self)
Box3f getBoundingBox (self)
ColoringType getColoringType (self)
int getDirtyFlags (self)
ConstColor getFrontColor (self, bool selected=True, ConstViewportId viewportId=...)
ConstViewportProperty_Color getFrontColorsForAllViewports (self, bool selected=True)
int getGlobalAlpha (self, ConstViewportId viewportId=...)
ConstViewportProperty_unsigned_char getGlobalAlphaForAllViewports (self)
std_vector_std_string getInfoLines (self)
bool getRedrawFlag (self, ConstViewportMask viewportMask)
float getShininess (self)
float getSpecularStrength (self)
bool getVisualizeProperty (self, ConstAnyVisualizeMaskEnum type, ConstViewportMask viewportMask)
bool globalClippedByPlane (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
ViewportMask globalClippedByPlaneMask (self)
int heapBytes (self)
bool isPickable (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
None renderUi (self, ConstUiRenderParams params)
None resetDirty (self)
None resetDirtyExceptMask (self, int mask)
bool showName (self)
bool useDefaultScenePropertiesOnDeserialization (self)
Public Member Functions inherited from mrmeshpy.ConstObject
 __init__ (self, *args, **kwargs)
ConstVisualObject asType (self)
Const_std_vector_std_shared_ptr_Object_const children (self)
Object cloneTree (self)
ConstChildren constChildren (self)
ConstObject find (self, str name)
ConstObject findCommonAncestor (self, ConstObject other)
int getModelHash (self)
bool globalVisibility (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
ViewportMask globalVisibilityMask (self)
bool hasModel (self)
bool hasVisualRepresentation (self)
bool isAncestor (self, ConstObject ancestor)
bool isAncillary (self)
bool isGlobalAncillary (self)
bool isLocked (self)
bool isParentLocked (self)
bool isSelected (self)
bool isVisible (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
str name (self)
ConstObject parent (self)
None resetRedrawFlag (self)
bool sameModels (self, ConstObject other)
Object shallowCloneTree (self)
Const_std_set_std_string tags (self)
ViewportMask visibilityMask (self)
AffineXf3f worldXf (self, ConstViewportId id=..., bool_output isDef=None)
ConstAffineXf3f xf (self, ConstViewportId id=..., bool_output isDef=None)
ConstViewportProperty_AffineXf3f xfsForAllViewports (self)
Public Member Functions inherited from mrmeshpy.ConstObjectChildrenHolder
 __init__ (self, *args, **kwargs)
Object getSharedPtr (self)

Static Public Member Functions

str StaticClassName ()
str StaticClassNameInPlural ()
str StaticTypeName ()
Static Public Member Functions inherited from mrmeshpy.ConstVisualObject
Box3f getWorldBox (*args, **kwargs)
bool render (*args, **kwargs)
None renderForPicker (*args, **kwargs)
Static Public Member Functions inherited from mrmeshpy.ConstObject
Box3f getWorldTreeBox (*args, **kwargs)

Detailed Description

Generated from:  MR::LineObject
Aliases:  ObjKindTraits_FeaturesObjectKind_Line.type

Object to show plane feature

Constructor & Destructor Documentation

◆ __init__()

mrmeshpy.ConstLineObject.__init__ ( self,
* args,
** kwargs )
__init__(*args, **kwargs)
Overloaded function.

1. __init__(self: meshlib.mrmeshpy.ConstLineObject) -> None

Creates simple plane object

2. __init__(self: meshlib.mrmeshpy.ConstLineObject, pointsToApprox: meshlib.mrmeshpy.Const_std_vector_Vector3_float) -> None

Finds best plane to approx given points

Member Function Documentation

◆ className()

str mrmeshpy.ConstLineObject.className ( self)

Reimplemented from mrmeshpy.ConstFeatureObject.

◆ classNameInPlural()

str mrmeshpy.ConstLineObject.classNameInPlural ( self)

Reimplemented from mrmeshpy.ConstFeatureObject.

◆ clone()

Object mrmeshpy.ConstLineObject.clone ( self)
clones this object only, without its children,
making new object the owner of all copied resources

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getAllSharedProperties()

Const_std_vector_FeatureObjectSharedProperty mrmeshpy.ConstLineObject.getAllSharedProperties ( self)
Create and generate list of bounded getters and setters for the main properties of feature object, together with prop. name for display and edit into UI.

Reimplemented from mrmeshpy.ConstFeatureObject.

◆ getBasePoint()

Vector3f mrmeshpy.ConstLineObject.getBasePoint ( self,
ConstViewportId id = ... )
Returns point considered as base for the feature

Reimplemented from mrmeshpy.ConstFeatureObject.

◆ getCenter()

Vector3f mrmeshpy.ConstLineObject.getCenter ( self,
ConstViewportId id = ... )
calculates center from xf

◆ getDirection()

Vector3f mrmeshpy.ConstLineObject.getDirection ( self,
ConstViewportId id = ... )
calculates direction from xf

◆ getLength()

float mrmeshpy.ConstLineObject.getLength ( self,
ConstViewportId id = ... )
calculates line size from xf

◆ getPointA()

Vector3f mrmeshpy.ConstLineObject.getPointA ( self,
ConstViewportId id = ... )
Returns the starting point, aka `center - dir * len/2`.

◆ getPointB()

Vector3f mrmeshpy.ConstLineObject.getPointB ( self,
ConstViewportId id = ... )
Returns the finishing point, aka `center + dir * len/2`.

◆ projectPoint()

FeatureObjectProjectPointResult mrmeshpy.ConstLineObject.projectPoint ( self,
ConstVector3f point,
ConstViewportId id = ... )
Since a point on an abstract feature is difficult to uniquely parameterize,
the projection function simultaneously returns the normal to the surface at the projection point.

Reimplemented from mrmeshpy.ConstFeatureObject.

◆ shallowClone()

Object mrmeshpy.ConstLineObject.shallowClone ( self)
clones this object only, without its children,
making new object to share resources with this object

Reimplemented from mrmeshpy.ConstVisualObject.

◆ StaticClassName()

str mrmeshpy.ConstLineObject.StaticClassName ( )
static
return human readable name of subclass

Reimplemented from mrmeshpy.ConstFeatureObject.

◆ StaticClassNameInPlural()

str mrmeshpy.ConstLineObject.StaticClassNameInPlural ( )
static
return human readable name of subclass in plural form

Reimplemented from mrmeshpy.ConstFeatureObject.

◆ StaticTypeName()

str mrmeshpy.ConstLineObject.StaticTypeName ( )
static
return name of subtype for serialization purposes

Reimplemented from mrmeshpy.ConstFeatureObject.

◆ typeName()

str mrmeshpy.ConstLineObject.typeName ( self)

Reimplemented from mrmeshpy.ConstFeatureObject.


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