mrmeshpy.VisualObject Class Reference

Inheritance diagram for mrmeshpy.VisualObject:

Public Member Functions
None	__init__ (self)
str	className (self)
str	classNameInPlural (self)
Object	clone (self)
None	copyAllSolidColors (self, VisualObject other)
std_vector_ViewportMask	getAllVisualizeProperties (self)
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)
bool	getRedrawFlag (self, ViewportMask viewportMask)
float	getShininess (self)
float	getSpecularStrength (self)
bool	getVisualizeProperty (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
ViewportMask	getVisualizePropertyMask (self, AnyVisualizeMaskEnum type)
bool	globalClippedByPlane (self, ViewportMask viewportMask='ViewportMask::any()')
ViewportMask	globalClippedByPlaneMask (self)
int	heapBytes (self)
bool	isPickable (self, ViewportMask viewportMask='ViewportMask::any()')
None	renderUi (self, UiRenderParams params)
None	resetColors (self)
None	resetDirty (self)
None	resetDirtyExceptMask (self, int mask)
None	resetFrontColor (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	setGlobalClippedByPlane (self, bool on, ViewportMask viewportMask='ViewportMask::all()')
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)
Object	shallowClone (self)
None	showName (self, bool on)
bool	showName (self)
bool	supportsVisualizeProperty (self, AnyVisualizeMaskEnum type)
None	toggleVisualizeProperty (self, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
str	typeName (self)
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)
bool	addTag (self, str tag)
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)
int	getModelHash (self)
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	isGlobalAncillary (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)
bool	removeTag (self, str tag)
None	resetRedrawFlag (self)
None	resetXf (self, ViewportId id='{}')
bool	sameModels (self, Object other)
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	setXf (self, AffineXf3f xf, ViewportId id='{}')
None	setXfsForAllViewports (self, ViewportProperty_AffineXf3f xf)
Object	shallowCloneTree (self)
None	sortChildren (self)
None	swap (self, Object other)
std_set_std_string	tags (self)
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	ClassName ()
str	ClassNameInPlural ()
str	TypeName ()
Box3f	getWorldBox (*args, **kwargs)
bool	render (*args, **kwargs)
None	renderForPicker (*args, **kwargs)
Static Public Member Functions inherited from mrmeshpy.Object
Box3f	getWorldTreeBox (*args, **kwargs)
Static Public Member Functions inherited from mrmeshpy.ObjectChildrenHolder
ObjectChildrenHolder	operator (*args, **kwargs)
ObjectChildrenHolder	operator (*args, **kwargs)

Detailed Description

Generated from:  MR::VisualObject
Aliases:  ChangeVisualizePropertyAction.Obj, ChangeObjectColorAction.Obj, ChangeColoringType.Obj, std_shared_ptr_VisualObject

Visual Object

Constructor & Destructor Documentation

__init__()

None mrmeshpy.VisualObject.__init__

(

self

)

Reimplemented from mrmeshpy.Object.

Reimplemented in mrmeshpy.AngleMeasurementObject, mrmeshpy.CircleObject, mrmeshpy.CircleObject, mrmeshpy.ConeObject, mrmeshpy.ConeObject, mrmeshpy.CylinderObject, mrmeshpy.CylinderObject, mrmeshpy.DistanceMeasurementObject, mrmeshpy.LineObject, mrmeshpy.LineObject, mrmeshpy.MeasurementObject, mrmeshpy.MeasurementObject, mrmeshpy.ObjectDistanceMap, mrmeshpy.ObjectGcode, mrmeshpy.ObjectLabel, mrmeshpy.ObjectLines, mrmeshpy.ObjectLinesHolder, mrmeshpy.ObjectMesh, mrmeshpy.ObjectMeshHolder, mrmeshpy.ObjectPoints, mrmeshpy.ObjectPoints, mrmeshpy.ObjectPointsHolder, mrmeshpy.ObjectVoxels, mrmeshpy.PlaneObject, mrmeshpy.PlaneObject, mrmeshpy.PointMeasurementObject, mrmeshpy.PointObject, mrmeshpy.PointObject, mrmeshpy.RadiusMeasurementObject, mrmeshpy.SphereObject, and mrmeshpy.SphereObject.

Member Function Documentation

ClassName()

str mrmeshpy.VisualObject.ClassName ( )

static

return human readable name of subclass

Reimplemented from mrmeshpy.Object.

Reimplemented in mrmeshpy.AngleMeasurementObject, mrmeshpy.CircleObject, mrmeshpy.ConeObject, mrmeshpy.CylinderObject, mrmeshpy.DistanceMeasurementObject, mrmeshpy.FeatureObject, mrmeshpy.LineObject, mrmeshpy.ObjectDistanceMap, mrmeshpy.ObjectGcode, mrmeshpy.ObjectLines, mrmeshpy.ObjectMesh, mrmeshpy.ObjectPoints, mrmeshpy.ObjectVoxels, mrmeshpy.PlaneObject, mrmeshpy.PointMeasurementObject, mrmeshpy.PointObject, mrmeshpy.RadiusMeasurementObject, and mrmeshpy.SphereObject.

className()

str mrmeshpy.VisualObject.className

(

self

)

Reimplemented from mrmeshpy.Object.

Reimplemented in mrmeshpy.AngleMeasurementObject, mrmeshpy.CircleObject, mrmeshpy.ConeObject, mrmeshpy.CylinderObject, mrmeshpy.DistanceMeasurementObject, mrmeshpy.FeatureObject, mrmeshpy.LineObject, mrmeshpy.ObjectDistanceMap, mrmeshpy.ObjectGcode, mrmeshpy.ObjectLines, mrmeshpy.ObjectMesh, mrmeshpy.ObjectPoints, mrmeshpy.ObjectVoxels, mrmeshpy.PlaneObject, mrmeshpy.PointMeasurementObject, mrmeshpy.PointObject, mrmeshpy.RadiusMeasurementObject, and mrmeshpy.SphereObject.

ClassNameInPlural()

str mrmeshpy.VisualObject.ClassNameInPlural ( )

static

return human readable name of subclass in plural form

Reimplemented from mrmeshpy.Object.

Reimplemented in mrmeshpy.AngleMeasurementObject, mrmeshpy.CircleObject, mrmeshpy.ConeObject, mrmeshpy.CylinderObject, mrmeshpy.DistanceMeasurementObject, mrmeshpy.FeatureObject, mrmeshpy.LineObject, mrmeshpy.ObjectDistanceMap, mrmeshpy.ObjectGcode, mrmeshpy.ObjectLines, mrmeshpy.ObjectMesh, mrmeshpy.ObjectPoints, mrmeshpy.ObjectVoxels, mrmeshpy.PlaneObject, mrmeshpy.PointMeasurementObject, mrmeshpy.PointObject, mrmeshpy.RadiusMeasurementObject, and mrmeshpy.SphereObject.

classNameInPlural()

str mrmeshpy.VisualObject.classNameInPlural

(

self

)

Reimplemented from mrmeshpy.Object.

Reimplemented in mrmeshpy.AngleMeasurementObject, mrmeshpy.CircleObject, mrmeshpy.ConeObject, mrmeshpy.CylinderObject, mrmeshpy.DistanceMeasurementObject, mrmeshpy.FeatureObject, mrmeshpy.LineObject, mrmeshpy.ObjectDistanceMap, mrmeshpy.ObjectGcode, mrmeshpy.ObjectLines, mrmeshpy.ObjectMesh, mrmeshpy.ObjectPoints, mrmeshpy.ObjectVoxels, mrmeshpy.PlaneObject, mrmeshpy.PointMeasurementObject, mrmeshpy.PointObject, mrmeshpy.RadiusMeasurementObject, and mrmeshpy.SphereObject.

clone()

Object mrmeshpy.VisualObject.clone

(

self

)

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

Reimplemented from mrmeshpy.Object.

Reimplemented in mrmeshpy.AngleMeasurementObject, mrmeshpy.CircleObject, mrmeshpy.ConeObject, mrmeshpy.CylinderObject, mrmeshpy.DistanceMeasurementObject, mrmeshpy.LineObject, mrmeshpy.ObjectDistanceMap, mrmeshpy.ObjectGcode, mrmeshpy.ObjectLabel, mrmeshpy.ObjectLines, mrmeshpy.ObjectLinesHolder, mrmeshpy.ObjectMesh, mrmeshpy.ObjectMeshHolder, mrmeshpy.ObjectPoints, mrmeshpy.ObjectPointsHolder, mrmeshpy.ObjectVoxels, mrmeshpy.PlaneObject, mrmeshpy.PointMeasurementObject, mrmeshpy.PointObject, mrmeshpy.RadiusMeasurementObject, and mrmeshpy.SphereObject.

copyAllSolidColors()

None mrmeshpy.VisualObject.copyAllSolidColors	(		self,
		VisualObject	other )

set all object solid colors (front/back/etc.) from other object for all viewports

Reimplemented in mrmeshpy.ObjectMeshHolder, and mrmeshpy.ObjectPointsHolder.

getAllVisualizeProperties()

std_vector_ViewportMask mrmeshpy.VisualObject.getAllVisualizeProperties

(

self

)

get all visualize properties masks

Reimplemented in mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter, mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_angle_DimensionsVisualizePropertyType_length, mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_length, mrmeshpy.FeatureObject, mrmeshpy.ObjectLabel, mrmeshpy.ObjectLinesHolder, mrmeshpy.ObjectMeshHolder, mrmeshpy.ObjectPointsHolder, and mrmeshpy.PointMeasurementObject.

getAmbientStrength()

float mrmeshpy.VisualObject.getAmbientStrength

(

self

)

returns intensity of non-directional light

getBackColor()

Color mrmeshpy.VisualObject.getBackColor	(		self,
		ViewportId	viewportId = '{}' )

returns backward color of object in given viewport

getBackColorsForAllViewports()

ViewportProperty_Color mrmeshpy.VisualObject.getBackColorsForAllViewports

(

self

)

returns backward color of object in all viewports

getBoundingBox()

Box3f mrmeshpy.VisualObject.getBoundingBox

(

self

)

returns cached bounding box of this object in local coordinates

getColoringType()

ColoringType mrmeshpy.VisualObject.getColoringType

(

self

)

returns the current coloring mode of the object

getDirtyFlags()

int mrmeshpy.VisualObject.getDirtyFlags

(

self

)

returns current dirty flags for the object

getFrontColor()

Color mrmeshpy.VisualObject.getFrontColor	(		self,
		bool	selected = True,
		ViewportId	viewportId = '{}' )

returns color of object when it is selected/not-selected (depending on argument) in given viewport

getFrontColorsForAllViewports()

ViewportProperty_Color mrmeshpy.VisualObject.getFrontColorsForAllViewports	(		self,
		bool	selected = True )

returns color of object when it is selected/not-selected (depending on argument) in all viewports

getGlobalAlpha()

int mrmeshpy.VisualObject.getGlobalAlpha	(		self,
		ViewportId	viewportId = '{}' )

returns global transparency alpha of object in given viewport

getGlobalAlphaForAllViewports()

ViewportProperty_unsigned_char mrmeshpy.VisualObject.getGlobalAlphaForAllViewports

(

self

)

returns global transparency alpha of object in all viewports

getInfoLines()

std_vector_std_string mrmeshpy.VisualObject.getInfoLines

(

self

)

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

Reimplemented from mrmeshpy.Object.

Reimplemented in mrmeshpy.AngleMeasurementObject, mrmeshpy.DistanceMeasurementObject, mrmeshpy.ObjectDistanceMap, mrmeshpy.ObjectGcode, mrmeshpy.ObjectLines, mrmeshpy.ObjectMesh, mrmeshpy.ObjectPoints, mrmeshpy.ObjectVoxels, and mrmeshpy.RadiusMeasurementObject.

getRedrawFlag()

bool mrmeshpy.VisualObject.getRedrawFlag	(		self,
		ViewportMask	viewportMask )

returns true if the object must be redrawn (due to dirty flags) in one of specified viewports

Reimplemented from mrmeshpy.Object.

Reimplemented in mrmeshpy.ObjectMeshHolder.

getShininess()

float mrmeshpy.VisualObject.getShininess

(

self

)

returns the current shininess visual value

getSpecularStrength()

float mrmeshpy.VisualObject.getSpecularStrength

(

self

)

returns intensity of reflections

getVisualizeProperty()

bool mrmeshpy.VisualObject.getVisualizeProperty	(		self,
		AnyVisualizeMaskEnum	type,
		ViewportMask	viewportMask )

returns true if the property is set at least in one viewport specified by the mask

getVisualizePropertyMask()

ViewportMask mrmeshpy.VisualObject.getVisualizePropertyMask	(		self,
		AnyVisualizeMaskEnum	type )

returns mask of viewports where given property is set

Reimplemented in mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter, mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_angle_DimensionsVisualizePropertyType_length, mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_length, mrmeshpy.FeatureObject, mrmeshpy.ObjectLabel, mrmeshpy.ObjectLinesHolder, mrmeshpy.ObjectMeshHolder, mrmeshpy.ObjectPointsHolder, and mrmeshpy.PointMeasurementObject.

getWorldBox()

Box3f mrmeshpy.VisualObject.getWorldBox ( * args, ** kwargs )

static

returns bounding box of this object in given viewport in world coordinates,
to get world bounding box of the object with all child objects, please call Object::getWorldTreeBox method

Reimplemented from mrmeshpy.Object.

Reimplemented in mrmeshpy.ObjectLabel, mrmeshpy.ObjectLinesHolder, mrmeshpy.ObjectMeshHolder, and mrmeshpy.ObjectPointsHolder.

globalClippedByPlane()

bool mrmeshpy.VisualObject.globalClippedByPlane	(		self,
		ViewportMask	viewportMask = 'ViewportMask::any()' )

returns true if this object or any of its parents is clipped by plane in any of given viewports

globalClippedByPlaneMask()

ViewportMask mrmeshpy.VisualObject.globalClippedByPlaneMask

(

self

)

returns all viewports where this object or any of its parents is clipped by plane

heapBytes()

int mrmeshpy.VisualObject.heapBytes

(

self

)

returns the amount of memory this object occupies on heap

Reimplemented from mrmeshpy.Object.

Reimplemented in mrmeshpy.ObjectDistanceMap, mrmeshpy.ObjectGcode, mrmeshpy.ObjectLabel, mrmeshpy.ObjectLinesHolder, mrmeshpy.ObjectMeshHolder, mrmeshpy.ObjectPointsHolder, and mrmeshpy.ObjectVoxels.

isPickable()

bool mrmeshpy.VisualObject.isPickable	(		self,
		ViewportMask	viewportMask = 'ViewportMask::any()' )

whether the object can be picked (by mouse) in any of given viewports

render()

bool mrmeshpy.VisualObject.render ( * args, ** kwargs )

static

draws this object for visualization
Returns true if something was drawn.

renderForPicker()

None mrmeshpy.VisualObject.renderForPicker ( * args, ** kwargs )

static

draws this object for picking

renderUi()

None mrmeshpy.VisualObject.renderUi	(		self,
		UiRenderParams	params )

draws this object for 2d UI

resetColors()

None mrmeshpy.VisualObject.resetColors

(

self

)

reset all object colors to their default values from the current theme

Reimplemented in mrmeshpy.ObjectMeshHolder, and mrmeshpy.ObjectPointsHolder.

resetDirty()

None mrmeshpy.VisualObject.resetDirty

(

self

)

resets all dirty flags (except for cache flags that will be reset automatically on cache update)

resetDirtyExceptMask()

None mrmeshpy.VisualObject.resetDirtyExceptMask	(		self,
		int	mask )

reset dirty flags without some specific bits (useful for lazy normals update)

resetFrontColor()

None mrmeshpy.VisualObject.resetFrontColor

(

self

)

reset basic object colors to their default values from the current theme

Reimplemented in mrmeshpy.ObjectLinesHolder, mrmeshpy.ObjectMeshHolder, mrmeshpy.ObjectPointsHolder, and mrmeshpy.ObjectVoxels.

setAllVisualizeProperties()

None mrmeshpy.VisualObject.setAllVisualizeProperties	(		self,
		std_vector_ViewportMask	properties )

set all visualize properties masks

setAmbientStrength()

None mrmeshpy.VisualObject.setAmbientStrength	(		self,
		float	ambientStrength )

sets intensity of non-directional light

setBackColor()

None mrmeshpy.VisualObject.setBackColor	(		self,
		Color	color,
		ViewportId	viewportId = '{}' )

sets backward color of object in given viewport

setBackColorsForAllViewports()

None mrmeshpy.VisualObject.setBackColorsForAllViewports	(		self,
		ViewportProperty_Color	val )

sets backward color of object in all viewports

setColoringType()

None mrmeshpy.VisualObject.setColoringType	(		self,
		ColoringType	coloringType )

sets coloring mode of the object with given argument

setDirtyFlags()

None mrmeshpy.VisualObject.setDirtyFlags	(		self,
		int	mask,
		bool	invalidateCaches = True )

sets some dirty flags for the object (to force its visual update)
\\param mask is a union of DirtyFlags flags
\\param invalidateCaches whether to automatically invalidate model caches (pass false here if you manually update the caches)

Reimplemented in mrmeshpy.ObjectGcode, mrmeshpy.ObjectLines, mrmeshpy.ObjectLinesHolder, mrmeshpy.ObjectMesh, mrmeshpy.ObjectMeshHolder, mrmeshpy.ObjectPoints, mrmeshpy.ObjectPointsHolder, and mrmeshpy.ObjectVoxels.

setFrontColor()

None mrmeshpy.VisualObject.setFrontColor	(		self,
		Color	color,
		bool	selected,
		ViewportId	viewportId = '{}' )

sets color of object when it is selected/not-selected (depending on argument) in given viewport

Reimplemented in mrmeshpy.ObjectGcode.

setFrontColorsForAllViewports()

None mrmeshpy.VisualObject.setFrontColorsForAllViewports	(		self,
		ViewportProperty_Color	val,
		bool	selected = True )

sets color of object when it is selected/not-selected (depending on argument) in all viewports

setGlobalAlpha()

None mrmeshpy.VisualObject.setGlobalAlpha	(		self,
		int	alpha,
		ViewportId	viewportId = '{}' )

sets global transparency alpha of object in given viewport

setGlobalAlphaForAllViewports()

None mrmeshpy.VisualObject.setGlobalAlphaForAllViewports	(		self,
		ViewportProperty_unsigned_char	val )

sets global transparency alpha of object in all viewports

setGlobalClippedByPlane()

None mrmeshpy.VisualObject.setGlobalClippedByPlane	(		self,
		bool	on,
		ViewportMask	viewportMask = 'ViewportMask::all()' )

if false deactivates clipped-by-plane for this object and all of its parents, otherwise sets clipped-by-plane for this this object only

setPickable()

None mrmeshpy.VisualObject.setPickable	(		self,
		bool	on,
		ViewportMask	viewportMask = 'ViewportMask::all()' )

sets the object as can/cannot be picked (by mouse) in all of given viewports

setShininess()

None mrmeshpy.VisualObject.setShininess	(		self,
		float	shininess )

sets shininess visual value of the object with given argument

setSpecularStrength()

None mrmeshpy.VisualObject.setSpecularStrength	(		self,
		float	specularStrength )

sets intensity of reflections

setUseDefaultScenePropertiesOnDeserialization()

None mrmeshpy.VisualObject.setUseDefaultScenePropertiesOnDeserialization	(		self,
		bool	useDefaultScenePropertiesOnDeserialization )

set whether the scene-related properties should get their values from SceneColors and SceneSettings instances
rather than from the input data on deserialization

setVisualizeProperty()

None mrmeshpy.VisualObject.setVisualizeProperty	(		self,
		bool	value,
		AnyVisualizeMaskEnum	type,
		ViewportMask	viewportMask )

set visual property in all viewports specified by the mask

setVisualizePropertyMask()

None mrmeshpy.VisualObject.setVisualizePropertyMask	(		self,
		AnyVisualizeMaskEnum	type,
		ViewportMask	viewportMask )

set visual property mask

shallowClone()

Object mrmeshpy.VisualObject.shallowClone

(

self

)

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

Reimplemented from mrmeshpy.Object.

Reimplemented in mrmeshpy.AngleMeasurementObject, mrmeshpy.CircleObject, mrmeshpy.ConeObject, mrmeshpy.CylinderObject, mrmeshpy.DistanceMeasurementObject, mrmeshpy.LineObject, mrmeshpy.ObjectDistanceMap, mrmeshpy.ObjectGcode, mrmeshpy.ObjectLabel, mrmeshpy.ObjectLines, mrmeshpy.ObjectLinesHolder, mrmeshpy.ObjectMesh, mrmeshpy.ObjectMeshHolder, mrmeshpy.ObjectPoints, mrmeshpy.ObjectPointsHolder, mrmeshpy.ObjectVoxels, mrmeshpy.PlaneObject, mrmeshpy.PointMeasurementObject, mrmeshpy.PointObject, mrmeshpy.RadiusMeasurementObject, and mrmeshpy.SphereObject.

showName() [1/2]

bool mrmeshpy.VisualObject.showName

(

self

)

returns whether object name is shown in any viewport

showName() [2/2]

None mrmeshpy.VisualObject.showName	(		self,
		bool	on )

shows/hides object name in all viewports

supportsVisualizeProperty()

bool mrmeshpy.VisualObject.supportsVisualizeProperty	(		self,
		AnyVisualizeMaskEnum	type )

Returns true if this class supports the property `type`. Otherwise passing it to the functions below is illegal.

Reimplemented in mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter, mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_angle_DimensionsVisualizePropertyType_length, mrmeshpy.AddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_length, mrmeshpy.FeatureObject, mrmeshpy.ObjectLinesHolder, mrmeshpy.ObjectMeshHolder, mrmeshpy.ObjectPointsHolder, and mrmeshpy.PointMeasurementObject.

toggleVisualizeProperty()

None mrmeshpy.VisualObject.toggleVisualizeProperty	(		self,
		AnyVisualizeMaskEnum	type,
		ViewportMask	viewportMask )

toggle visual property in all viewports specified by the mask

TypeName()

str mrmeshpy.VisualObject.TypeName ( )

static

return name of subtype for serialization purposes

Reimplemented from mrmeshpy.Object.

Reimplemented in mrmeshpy.AngleMeasurementObject, mrmeshpy.CircleObject, mrmeshpy.ConeObject, mrmeshpy.CylinderObject, mrmeshpy.DistanceMeasurementObject, mrmeshpy.FeatureObject, mrmeshpy.LineObject, mrmeshpy.ObjectDistanceMap, mrmeshpy.ObjectGcode, mrmeshpy.ObjectLabel, mrmeshpy.ObjectLines, mrmeshpy.ObjectLinesHolder, mrmeshpy.ObjectMesh, mrmeshpy.ObjectMeshHolder, mrmeshpy.ObjectPoints, mrmeshpy.ObjectPointsHolder, mrmeshpy.ObjectVoxels, mrmeshpy.PlaneObject, mrmeshpy.PointMeasurementObject, mrmeshpy.PointObject, mrmeshpy.RadiusMeasurementObject, and mrmeshpy.SphereObject.

typeName()

str mrmeshpy.VisualObject.typeName

(

self

)

Reimplemented from mrmeshpy.Object.

Reimplemented in mrmeshpy.AngleMeasurementObject, mrmeshpy.CircleObject, mrmeshpy.ConeObject, mrmeshpy.CylinderObject, mrmeshpy.DistanceMeasurementObject, mrmeshpy.FeatureObject, mrmeshpy.LineObject, mrmeshpy.ObjectDistanceMap, mrmeshpy.ObjectGcode, mrmeshpy.ObjectLabel, mrmeshpy.ObjectLines, mrmeshpy.ObjectLinesHolder, mrmeshpy.ObjectMesh, mrmeshpy.ObjectMeshHolder, mrmeshpy.ObjectPoints, mrmeshpy.ObjectPointsHolder, mrmeshpy.ObjectVoxels, mrmeshpy.PlaneObject, mrmeshpy.PointMeasurementObject, mrmeshpy.PointObject, mrmeshpy.RadiusMeasurementObject, and mrmeshpy.SphereObject.

useDefaultScenePropertiesOnDeserialization()

bool mrmeshpy.VisualObject.useDefaultScenePropertiesOnDeserialization

(

self

)

whether the scene-related properties should get their values from SceneColors and SceneSettings instances
rather than from the input data on deserialization

---

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

• mrmeshpy.pyi