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

Public Member Functions

 __init__ (self, *args, **kwargs)
str className (self)
str classNameInPlural (self)
Object clone (self)
float computeRadiusOrDiameter (self)
bool getDrawAsDiameter (self)
std_vector_std_string getInfoLines (self)
bool getIsSpherical (self)
Vector3f getLocalCenter (self)
Vector3f getLocalNormal (self)
Vector3f getLocalRadiusAsVector (self)
float getVisualLengthMultiplier (self)
Vector3f getWorldCenter (self)
Vector3f getWorldNormal (self)
Vector3f getWorldRadiusAsVector (self)
Object shallowClone (self)
str typeName (self)
Public Member Functions inherited from mrmeshpy.ConstMeasurementObject
 __init__ (self, *args, **kwargs)
Public Member Functions inherited from mrmeshpy.ConstVisualObject
 __init__ (self, *args, **kwargs)
std_vector_ViewportMask getAllVisualizeProperties (self)
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)
bool getRedrawFlag (self, ConstViewportMask viewportMask)
float getShininess (self)
float getSpecularStrength (self)
bool getVisualizeProperty (self, ConstAnyVisualizeMaskEnum type, ConstViewportMask viewportMask)
ConstViewportMask getVisualizePropertyMask (self, ConstAnyVisualizeMaskEnum type)
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 supportsVisualizeProperty (self, ConstAnyVisualizeMaskEnum type)
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::RadiusMeasurementObject

Represents a radius measurement.

Constructor & Destructor Documentation

◆ __init__()

mrmeshpy.ConstRadiusMeasurementObject.__init__ ( self,
* args,
** kwargs )
__init__(self: meshlib.mrmeshpy.ConstRadiusMeasurementObject) -> None

The xf encodes the radius: the origin is the center point, and (1,0,0) is the end point.
For non-spherical radiuses, (0,0,1) is the circle normal.

Member Function Documentation

◆ className()

str mrmeshpy.ConstRadiusMeasurementObject.className ( self)

Reimplemented from mrmeshpy.ConstVisualObject.

◆ classNameInPlural()

str mrmeshpy.ConstRadiusMeasurementObject.classNameInPlural ( self)

Reimplemented from mrmeshpy.ConstVisualObject.

◆ clone()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ computeRadiusOrDiameter()

float mrmeshpy.ConstRadiusMeasurementObject.computeRadiusOrDiameter ( self)
Computes the radius/diameter value, as if by `getLocalRadiusAsVector()`, possibly multiplied by two if `getDrawAsDiameter()`.

◆ getDrawAsDiameter()

bool mrmeshpy.ConstRadiusMeasurementObject.getDrawAsDiameter ( self)
Whether we should draw this as a diameter instead of a radius.

◆ getInfoLines()

std_vector_std_string mrmeshpy.ConstRadiusMeasurementObject.getInfoLines ( self)
return several info lines that can better describe the object in the UI

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getIsSpherical()

bool mrmeshpy.ConstRadiusMeasurementObject.getIsSpherical ( self)
Whether this is a sphere radius, as opposed to circle/cylinder radius.

◆ getLocalCenter()

Vector3f mrmeshpy.ConstRadiusMeasurementObject.getLocalCenter ( self)
Get the center in local coordinates.

◆ getLocalNormal()

Vector3f mrmeshpy.ConstRadiusMeasurementObject.getLocalNormal ( self)

◆ getLocalRadiusAsVector()

Vector3f mrmeshpy.ConstRadiusMeasurementObject.getLocalRadiusAsVector ( self)

◆ getVisualLengthMultiplier()

float mrmeshpy.ConstRadiusMeasurementObject.getVisualLengthMultiplier ( self)
The visual leader line length multiplier, relative to the radius.
You're recommended to set a min absolute value for the resulting length when rendering.

◆ getWorldCenter()

Vector3f mrmeshpy.ConstRadiusMeasurementObject.getWorldCenter ( self)
Get the center in world coordinates.

◆ getWorldNormal()

Vector3f mrmeshpy.ConstRadiusMeasurementObject.getWorldNormal ( self)
The preferred radius normal, for non-spherical radiuses.

◆ getWorldRadiusAsVector()

Vector3f mrmeshpy.ConstRadiusMeasurementObject.getWorldRadiusAsVector ( self)
The length of this vector is the radius, and the direction is the preferred line drawing direction.

◆ shallowClone()

Object mrmeshpy.ConstRadiusMeasurementObject.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.ConstRadiusMeasurementObject.StaticClassName ( )
static
return human readable name of subclass

Reimplemented from mrmeshpy.ConstVisualObject.

◆ StaticClassNameInPlural()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ StaticTypeName()

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

Reimplemented from mrmeshpy.ConstVisualObject.

◆ typeName()

str mrmeshpy.ConstRadiusMeasurementObject.typeName ( self)

Reimplemented from mrmeshpy.ConstVisualObject.


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