meshlib.mrmeshpy.RadiusMeasurementObject Class Reference

Inheritance diagram for meshlib.mrmeshpy.RadiusMeasurementObject:

Public Member Functions
None	__init__ (self)
Object	clone (self)
float	computeRadiusOrDiameter (self)
str	getClassName (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)
None	setDrawAsDiameter (self, bool value)
None	setIsSpherical (self, bool value)
None	setLocalCenter (self, Vector3f center)
None	setLocalRadiusAsVector (self, Vector3f radiusVec, Vector3f normal)
None	setLocalRadiusAsVector (self, Vector3f radiusVec)
None	setVisualLengthMultiplier (self, float value)
Object	shallowClone (self)
str	typeName (self)
Public Member Functions inherited from meshlib.mrmeshpy.VisualObject
None	copyColors (self, VisualObject src, VertMap thisToSrc, FaceMap thisToSrcFaces='MR::FaceMap{}')
std_vector_ViewportMask	getAllVisualizeProperties (self)
float	getAmbientStrength (self)
Color	getBackColor (self, ViewportId viewportId='MR::ViewportId{}')
ViewportProperty_Color	getBackColorsForAllViewports (self)
Box3f	getBoundingBox (self)
ColoringType	getColoringType (self)
int	getDirtyFlags (self)
Color	getFrontColor (self, bool selected=True, ViewportId viewportId='MR::ViewportId{}')
ViewportProperty_Color	getFrontColorsForAllViewports (self, bool selected=True)
int	getGlobalAlpha (self, ViewportId viewportId='MR::ViewportId{}')
ViewportProperty_unsigned_char	getGlobalAlphaForAllViewports (self)
std_vector_PositionedText	getLabels (self)
Color	getLabelsColor (self, ViewportId viewportId='MR::ViewportId{}')
ViewportProperty_Color	getLabelsColorsForAllViewports (self)
bool	getRedrawFlag (self, ViewportMask viewportMask)
float	getShininess (self)
float	getSpecularStrength (self)
VertColors	getVertsColorMap (self)
bool	getVisualizeProperty (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
ViewportMask	getVisualizePropertyMask (self, AnyVisualizeMaskEnum type)
int	heapBytes (self)
bool	isPickable (self, ViewportMask viewportMask='ViewportMask::any()')
None	renderUi (self, UiRenderParams params)
None	resetDirty (self)
None	setAllVisualizeProperties (self, std_vector_ViewportMask properties)
None	setAmbientStrength (self, float ambientStrength)
None	setBackColor (self, Color color, ViewportId viewportId='MR::ViewportId{}')
None	setBackColorsForAllViewports (self, ViewportProperty_Color val)
None	setColoringType (self, ColoringType coloringType)
None	setDirtyFlags (self, int mask, bool invalidateCaches=True)
None	setFrontColor (self, Color color, bool selected, ViewportId viewportId='MR::ViewportId{}')
None	setFrontColorsForAllViewports (self, ViewportProperty_Color val, bool selected=True)
None	setGlobalAlpha (self, int alpha, ViewportId viewportId='MR::ViewportId{}')
None	setGlobalAlphaForAllViewports (self, ViewportProperty_unsigned_char val)
None	setLabels (self, std_vector_PositionedText labels)
None	setLabelsColor (self, Color color, ViewportId viewportId='MR::ViewportId{}')
None	setLabelsColorsForAllViewports (self, ViewportProperty_Color val)
None	setPickable (self, bool on, ViewportMask viewportMask='ViewportMask::all()')
None	setShininess (self, float shininess)
None	setSpecularStrength (self, float specularStrength)
None	setUseDefaultScenePropertiesOnDeserialization (self, bool useDefaultScenePropertiesOnDeserialization)
None	setVertsColorMap (self, VertColors vertsColorMap)
None	setVisualizeProperty (self, bool value, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
None	setVisualizePropertyMask (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
None	showLabels (self, bool on)
bool	showLabels (self)
None	showName (self, bool on)
bool	showName (self)
bool	supportsVisualizeProperty (self, AnyVisualizeMaskEnum type)
None	toggleVisualizeProperty (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
None	updateVertsColorMap (self, VertColors vertsColorMap)
bool	useDefaultScenePropertiesOnDeserialization (self)
Public Member Functions inherited from meshlib.mrmeshpy.Object
bool	addChild (self, Object child, bool recognizedChild=True)
bool	addChildBefore (self, Object newChild, Object existingChild)
None	applyScale (self, float scaleFactor)
VisualObject	asType_VisualObject (self)
VisualObject	asType_VisualObject (self)
std_vector_std_shared_ptr_Object	children (self)
std_vector_std_shared_ptr_Object_const	children (self)
Object	cloneTree (self)
bool	detachFromParent (self)
Object	find (self, str name)
Object	find (self, str name)
Object	findCommonAncestor (self, Object other)
Object	findCommonAncestor (self, Object other)
bool	globalVisibility (self, ViewportMask viewportMask='ViewportMask::any()')
ViewportMask	globalVisibilityMask (self)
bool	hasModel (self)
bool	hasVisualRepresentation (self)
bool	isAncestor (self, Object ancestor)
bool	isAncillary (self)
bool	isLocked (self)
bool	isParentLocked (self)
bool	isSelected (self)
bool	isVisible (self, ViewportMask viewportMask='ViewportMask::any()')
str	name (self)
Object	parent (self)
Object	parent (self)
None	removeAllChildren (self)
bool	removeChild (self, Object child)
bool	removeChild (self, Object child)
None	resetRedrawFlag (self)
None	resetXf (self, ViewportId id='MR::ViewportId{}')
bool	select (self, bool on)
None	setAncillary (self, bool ancillary)
None	setGlobalVisibility (self, bool on, ViewportMask viewportMask='ViewportMask::any()')
None	setLocked (self, bool on)
None	setName (self, str name)
None	setParentLocked (self, bool lock)
None	setVisibilityMask (self, ViewportMask viewportMask)
None	setVisible (self, bool on, ViewportMask viewportMask='ViewportMask::all()')
None	setWorldXf (self, AffineXf3f xf, ViewportId id='MR::ViewportId{}')
None	setXf (self, AffineXf3f xf, ViewportId id='MR::ViewportId{}')
None	setXfsForAllViewports (self, ViewportProperty_AffineXf3f xf)
Object	shallowCloneTree (self)
None	sortChildren (self)
None	swap (self, Object other)
ViewportMask	visibilityMask (self)
AffineXf3f	worldXf (self, ViewportId id='MR::ViewportId{}', bool_output isDef=None)
AffineXf3f	xf (self, ViewportId id='MR::ViewportId{}', bool_output isDef=None)
ViewportProperty_AffineXf3f	xfsForAllViewports (self)
Public Member Functions inherited from meshlib.mrmeshpy.ObjectChildrenHolder
Object	getSharedPtr (self)

Static Public Member Functions
str	TypeName ()
Static Public Member Functions inherited from meshlib.mrmeshpy.VisualObject
Box3f	getWorldBox (*args, **kwargs)
bool	render (*args, **kwargs)
None	renderForPicker (*args, **kwargs)
Static Public Member Functions inherited from meshlib.mrmeshpy.Object
Box3f	getWorldTreeBox (*args, **kwargs)

Additional Inherited Members
Static Protected Member Functions inherited from meshlib.mrmeshpy.ObjectChildrenHolder
ObjectChildrenHolder	_Equal (*args, **kwargs)
ObjectChildrenHolder	_Equal (*args, **kwargs)

Detailed Description

Generated from:  MR::RadiusMeasurementObject

Represents a radius measurement.

Constructor & Destructor Documentation

__init__()

None meshlib.mrmeshpy.RadiusMeasurementObject.__init__

(

self

)

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.

Reimplemented from meshlib.mrmeshpy.MeasurementObject.

Member Function Documentation

clone()

Object meshlib.mrmeshpy.RadiusMeasurementObject.clone

(

self

)

clones this object only, without its children,
making new object the owner of all copied resources

Reimplemented from meshlib.mrmeshpy.VisualObject.

computeRadiusOrDiameter()

float meshlib.mrmeshpy.RadiusMeasurementObject.computeRadiusOrDiameter

(

self

)

Computes the radius/diameter value, as if by `getLocalRadiusAsVector()`, possibly multiplied by two if `getDrawAsDiameter()`.

getClassName()

str meshlib.mrmeshpy.RadiusMeasurementObject.getClassName

(

self

)

return human readable name of subclass

Reimplemented from meshlib.mrmeshpy.VisualObject.

getDrawAsDiameter()

bool meshlib.mrmeshpy.RadiusMeasurementObject.getDrawAsDiameter

(

self

)

Whether we should draw this as a diameter instead of a radius.

getInfoLines()

std_vector_std_string meshlib.mrmeshpy.RadiusMeasurementObject.getInfoLines

(

self

)

return several info lines that can better describe the object in the UI

Reimplemented from meshlib.mrmeshpy.VisualObject.

getIsSpherical()

bool meshlib.mrmeshpy.RadiusMeasurementObject.getIsSpherical

(

self

)

Whether this is a sphere radius, as opposed to circle/cylinder radius.

getLocalCenter()

Vector3f meshlib.mrmeshpy.RadiusMeasurementObject.getLocalCenter

(

self

)

Get the center in local coordinates.

getLocalNormal()

Vector3f meshlib.mrmeshpy.RadiusMeasurementObject.getLocalNormal

(

self

)

getLocalRadiusAsVector()

Vector3f meshlib.mrmeshpy.RadiusMeasurementObject.getLocalRadiusAsVector

(

self

)

getVisualLengthMultiplier()

float meshlib.mrmeshpy.RadiusMeasurementObject.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 meshlib.mrmeshpy.RadiusMeasurementObject.getWorldCenter

(

self

)

Get the center in world coordinates.

getWorldNormal()

Vector3f meshlib.mrmeshpy.RadiusMeasurementObject.getWorldNormal

(

self

)

The preferred radius normal, for non-spherical radiuses.

getWorldRadiusAsVector()

Vector3f meshlib.mrmeshpy.RadiusMeasurementObject.getWorldRadiusAsVector

(

self

)

The length of this vector is the radius, and the direction is the preferred line drawing direction.

setDrawAsDiameter()

None meshlib.mrmeshpy.RadiusMeasurementObject.setDrawAsDiameter	(		self,
		bool	value )

setIsSpherical()

None meshlib.mrmeshpy.RadiusMeasurementObject.setIsSpherical	(		self,
		bool	value )

setLocalCenter()

None meshlib.mrmeshpy.RadiusMeasurementObject.setLocalCenter	(		self,
		Vector3f	center )

setLocalRadiusAsVector() [1/2]

None meshlib.mrmeshpy.RadiusMeasurementObject.setLocalRadiusAsVector	(		self,
		Vector3f	radiusVec )

Same, but without a preferred normal.

setLocalRadiusAsVector() [2/2]

None meshlib.mrmeshpy.RadiusMeasurementObject.setLocalRadiusAsVector	(		self,
		Vector3f	radiusVec,
		Vector3f	normal )

Sets the local radius vector (the length of which is the radius value),
  and also the radius normal (which is ignored for spherical radiuses).
The normal is automatically normalized and made perpendicular to the `radiusVec`.

setVisualLengthMultiplier()

None meshlib.mrmeshpy.RadiusMeasurementObject.setVisualLengthMultiplier	(		self,
		float	value )

shallowClone()

Object meshlib.mrmeshpy.RadiusMeasurementObject.shallowClone

(

self

)

clones this object only, without its children,
making new object to share resources with this object

Reimplemented from meshlib.mrmeshpy.VisualObject.

TypeName()

str meshlib.mrmeshpy.RadiusMeasurementObject.TypeName ( )

static

return name of subtype for serialization purposes

Reimplemented from meshlib.mrmeshpy.VisualObject.

typeName()

str meshlib.mrmeshpy.RadiusMeasurementObject.typeName

(

self

)

Reimplemented from meshlib.mrmeshpy.VisualObject.

---

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

• mrmeshpy.pyi