mrmeshpy.PlaneObject Class Reference

Inheritance diagram for mrmeshpy.PlaneObject:

Public Member Functions
None	__init__ (self)
None	__init__ (self, std_vector_Vector3_float pointsToApprox)
Matrix3f	calcLocalBasis (self, ViewportId id='{}')
Object	clone (self)
std_vector_FeatureObjectSharedProperty	getAllSharedProperties (self)
Vector3f	getBasePoint (self, ViewportId id='{}')
Vector3f	getCenter (self, ViewportId id='{}')
str	getClassName (self)
str	getClassNameInPlural (self)
Vector3f	getNormal (self, ViewportId id='{}')
float	getSize (self, ViewportId id='{}')
float	getSizeX (self, ViewportId id='{}')
float	getSizeY (self, ViewportId id='{}')
FeatureObjectProjectPointResult	projectPoint (self, Vector3f point, ViewportId id='{}')
None	setCenter (self, Vector3f center, ViewportId id='{}')
None	setNormal (self, Vector3f normal, ViewportId id='{}')
None	setSize (self, float size, ViewportId id='{}')
None	setSizeX (self, float size, ViewportId id='{}')
None	setSizeY (self, float size, ViewportId id='{}')
Object	shallowClone (self)
str	typeName (self)
Public Member Functions inherited from mrmeshpy.FeatureObject
std_vector_ViewportMask	getAllVisualizeProperties (self)
Color	getDecorationsColor (self, bool selected, ViewportId viewportId='{}', bool_output isDef=None)
ViewportProperty_Color	getDecorationsColorForAllViewports (self, bool selected)
float	getLineWidth (self)
float	getMainFeatureAlpha (self)
float	getPointSize (self)
Matrix3f	getRotationMatrix (self, ViewportId id='{}', bool_output isDef=None)
Matrix3f	getScaleShearMatrix (self, ViewportId id='{}', bool_output isDef=None)
float	getSubfeatureAlphaLines (self)
float	getSubfeatureAlphaMesh (self)
float	getSubfeatureAlphaPoints (self)
float	getSubfeatureLineWidth (self)
float	getSubfeaturePointSize (self)
ViewportMask	getVisualizePropertyMask (self, AnyVisualizeMaskEnum type)
None	resetXf (self, ViewportId id='{}')
None	setDecorationsColor (self, Color color, bool selected, ViewportId viewportId='{}')
None	setDecorationsColorForAllViewports (self, ViewportProperty_Color val, bool selected)
None	setLineWidth (self, float lineWidth)
None	setMainFeatureAlpha (self, float alpha)
None	setPointSize (self, float pointSize)
None	setSubfeatureAlphaLines (self, float alpha)
None	setSubfeatureAlphaMesh (self, float alpha)
None	setSubfeatureAlphaPoints (self, float alpha)
None	setSubfeatureLineWidth (self, float lineWidth)
None	setSubfeaturePointSize (self, float pointSize)
None	setXf (self, AffineXf3f xf, ViewportId id='{}')
bool	supportsVisualizeProperty (self, AnyVisualizeMaskEnum type)
Public Member Functions inherited from mrmeshpy.VisualObject
float	getAmbientStrength (self)
Color	getBackColor (self, ViewportId viewportId='{}')
ViewportProperty_Color	getBackColorsForAllViewports (self)
Box3f	getBoundingBox (self)
ColoringType	getColoringType (self)
int	getDirtyFlags (self)
Color	getFrontColor (self, bool selected=True, ViewportId viewportId='{}')
ViewportProperty_Color	getFrontColorsForAllViewports (self, bool selected=True)
int	getGlobalAlpha (self, ViewportId viewportId='{}')
ViewportProperty_unsigned_char	getGlobalAlphaForAllViewports (self)
std_vector_std_string	getInfoLines (self)
std_vector_PositionedText	getLabels (self)
Color	getLabelsColor (self, ViewportId viewportId='{}')
ViewportProperty_Color	getLabelsColorsForAllViewports (self)
bool	getRedrawFlag (self, ViewportMask viewportMask)
float	getShininess (self)
float	getSpecularStrength (self)
bool	getVisualizeProperty (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
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='{}')
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='{}')
None	setFrontColorsForAllViewports (self, ViewportProperty_Color val, bool selected=True)
None	setGlobalAlpha (self, int alpha, ViewportId viewportId='{}')
None	setGlobalAlphaForAllViewports (self, ViewportProperty_unsigned_char val)
None	setLabels (self, std_vector_PositionedText labels)
None	setLabelsColor (self, Color color, ViewportId 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	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)
None	toggleVisualizeProperty (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
bool	useDefaultScenePropertiesOnDeserialization (self)
Public Member Functions inherited from 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)
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='{}')
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='{}', bool_output isDef=None)
AffineXf3f	xf (self, ViewportId id='{}', bool_output isDef=None)
ViewportProperty_AffineXf3f	xfsForAllViewports (self)
Public Member Functions inherited from mrmeshpy.ObjectChildrenHolder
Object	getSharedPtr (self)

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

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

Detailed Description

Generated from:  MR::PlaneObject
Aliases:  ObjKindTraits_FeaturesObjectKind_Plane.type

Object to show plane feature
\\ingroup FeaturesGroup

Constructor & Destructor Documentation

__init__() [1/2]

None mrmeshpy.PlaneObject.__init__

(

self

)

Creates simple plane object

Reimplemented from mrmeshpy.VisualObject.

__init__() [2/2]

None mrmeshpy.PlaneObject.__init__	(		self,
		std_vector_Vector3_float	pointsToApprox )

Finds best plane to approx given points

Reimplemented from mrmeshpy.VisualObject.

Member Function Documentation

calcLocalBasis()

Matrix3f mrmeshpy.PlaneObject.calcLocalBasis	(		self,
		ViewportId	id = '{}' )

calculates normalized directions of X,Y axis of the plane and normal as Z

clone()

Object mrmeshpy.PlaneObject.clone

(

self

)

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

Reimplemented from mrmeshpy.VisualObject.

getAllSharedProperties()

std_vector_FeatureObjectSharedProperty mrmeshpy.PlaneObject.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.FeatureObject.

getBasePoint()

Vector3f mrmeshpy.PlaneObject.getBasePoint	(		self,
		ViewportId	id = '{}' )

Returns point considered as base for the feature

Reimplemented from mrmeshpy.FeatureObject.

getCenter()

Vector3f mrmeshpy.PlaneObject.getCenter	(		self,
		ViewportId	id = '{}' )

calculates center from xf

getClassName()

str mrmeshpy.PlaneObject.getClassName

(

self

)

return human readable name of subclass

Reimplemented from mrmeshpy.VisualObject.

getClassNameInPlural()

str mrmeshpy.PlaneObject.getClassNameInPlural

(

self

)

return human readable name of subclass in plural form

Reimplemented from mrmeshpy.VisualObject.

getNormal()

Vector3f mrmeshpy.PlaneObject.getNormal	(		self,
		ViewportId	id = '{}' )

calculates normal from xf

Reimplemented from mrmeshpy.FeatureObject.

getSize()

float mrmeshpy.PlaneObject.getSize	(		self,
		ViewportId	id = '{}' )

calculates plane size from xf

getSizeX()

float mrmeshpy.PlaneObject.getSizeX	(		self,
		ViewportId	id = '{}' )

getSizeY()

float mrmeshpy.PlaneObject.getSizeY	(		self,
		ViewportId	id = '{}' )

projectPoint()

FeatureObjectProjectPointResult mrmeshpy.PlaneObject.projectPoint	(		self,
		Vector3f	point,
		ViewportId	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.FeatureObject.

setCenter()

None mrmeshpy.PlaneObject.setCenter	(		self,
		Vector3f	center,
		ViewportId	id = '{}' )

updates xf to fit given center

setNormal()

None mrmeshpy.PlaneObject.setNormal	(		self,
		Vector3f	normal,
		ViewportId	id = '{}' )

updates xf to fit given normal

setSize()

None mrmeshpy.PlaneObject.setSize	(		self,
		float	size,
		ViewportId	id = '{}' )

updates xf to scale size

setSizeX()

None mrmeshpy.PlaneObject.setSizeX	(		self,
		float	size,
		ViewportId	id = '{}' )

setSizeY()

None mrmeshpy.PlaneObject.setSizeY	(		self,
		float	size,
		ViewportId	id = '{}' )

shallowClone()

Object mrmeshpy.PlaneObject.shallowClone

(

self

)

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

Reimplemented from mrmeshpy.VisualObject.

TypeName()

str mrmeshpy.PlaneObject.TypeName ( )

static

return name of subtype for serialization purposes

Reimplemented from mrmeshpy.VisualObject.

typeName()

str mrmeshpy.PlaneObject.typeName

(

self

)

Reimplemented from mrmeshpy.VisualObject.

---

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

• mrmeshpy.pyi