meshlib.mrmeshpy.ObjectGcode Class Reference

Inheritance diagram for meshlib.mrmeshpy.ObjectGcode:

Public Member Functions
None	__init__ (self)
std_vector_GcodeProcessor_MoveAction	actionList (self)
Object	clone (self)
std_vector_std_string	gcodeSource (self)
CNCMachineSettings	getCNCMachineSettings (self)
str	getClassName (self)
Color	getIdleColor (self)
std_vector_std_string	getInfoLines (self)
int	heapBytes (self)
bool	isFeedrateGradient (self)
std_vector_int	segmentToSourceLineMap (self)
bool	select (self, bool isSelected)
None	setCNCMachineSettings (self, CNCMachineSettings cncSettings)
None	setDirtyFlags (self, int mask, bool invalidateCaches=True)
None	setFrontColor (self, Color color, bool selected, ViewportId viewportId='MR::ViewportId{}')
None	setGcodeSource (self, std_vector_std_string gcodeSource)
None	setIdleColor (self, Color color)
Object	shallowClone (self)
None	switchFeedrateGradient (self, bool isFeedrateGradientEnabled)
str	typeName (self)
Public Member Functions inherited from meshlib.mrmeshpy.ObjectLinesHolder
None	applyScale (self, float scaleFactor)
std_vector_ViewportMask	getAllVisualizeProperties (self)
float	getLineWidth (self)
UndirectedEdgeColors	getLinesColorMap (self)
float	getPointSize (self)
ViewportMask	getVisualizePropertyMask (self, AnyVisualizeMaskEnum type)
bool	hasModel (self)
bool	hasVisualRepresentation (self)
int	numComponents (self)
Polyline3	polyline (self)
None	setLineWidth (self, float width)
None	setLinesColorMap (self, UndirectedEdgeColors linesColorMap)
None	setPointSize (self, float size)
bool	supportsVisualizeProperty (self, AnyVisualizeMaskEnum type)
float	totalLength (self)
None	updateLinesColorMap (self, UndirectedEdgeColors updated)
Public Member Functions inherited from meshlib.mrmeshpy.VisualObject
None	copyColors (self, VisualObject src, VertMap thisToSrc, FaceMap thisToSrcFaces='MR::FaceMap{}')
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)
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	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)
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)
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	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{}')
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.ObjectLinesHolder
Box3f	getWorldBox (*args, **kwargs)
Static Public Member Functions inherited from meshlib.mrmeshpy.VisualObject
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::ObjectGcode

an object that stores a g-code
\\ingroup DataModelGroup

Constructor & Destructor Documentation

__init__()

None meshlib.mrmeshpy.ObjectGcode.__init__

(

self

)

Reimplemented from meshlib.mrmeshpy.ObjectLinesHolder.

Member Function Documentation

actionList()

std_vector_GcodeProcessor_MoveAction meshlib.mrmeshpy.ObjectGcode.actionList

(

self

)

get action list (produced from g-code source)

clone()

Object meshlib.mrmeshpy.ObjectGcode.clone

(

self

)

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

Reimplemented from meshlib.mrmeshpy.ObjectLinesHolder.

gcodeSource()

std_vector_std_string meshlib.mrmeshpy.ObjectGcode.gcodeSource

(

self

)

getClassName()

str meshlib.mrmeshpy.ObjectGcode.getClassName

(

self

)

return human readable name of subclass

Reimplemented from meshlib.mrmeshpy.VisualObject.

getCNCMachineSettings()

CNCMachineSettings meshlib.mrmeshpy.ObjectGcode.getCNCMachineSettings

(

self

)

getIdleColor()

Color meshlib.mrmeshpy.ObjectGcode.getIdleColor

(

self

)

getInfoLines()

std_vector_std_string meshlib.mrmeshpy.ObjectGcode.getInfoLines

(

self

)

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

Reimplemented from meshlib.mrmeshpy.VisualObject.

heapBytes()

int meshlib.mrmeshpy.ObjectGcode.heapBytes

(

self

)

returns the amount of memory this object occupies on heap

Reimplemented from meshlib.mrmeshpy.ObjectLinesHolder.

isFeedrateGradient()

bool meshlib.mrmeshpy.ObjectGcode.isFeedrateGradient

(

self

)

segmentToSourceLineMap()

std_vector_int meshlib.mrmeshpy.ObjectGcode.segmentToSourceLineMap

(

self

)

get mapping of tool path polyline segment id to source line number of g-code source

select()

bool meshlib.mrmeshpy.ObjectGcode.select	(		self,
		bool	on )

selects the object, returns true if value changed, otherwise returns false

Reimplemented from meshlib.mrmeshpy.Object.

setCNCMachineSettings()

None meshlib.mrmeshpy.ObjectGcode.setCNCMachineSettings	(		self,
		CNCMachineSettings	cncSettings )

setDirtyFlags()

None meshlib.mrmeshpy.ObjectGcode.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 from meshlib.mrmeshpy.ObjectLinesHolder.

setFrontColor()

None meshlib.mrmeshpy.ObjectGcode.setFrontColor	(		self,
		Color	color,
		bool	selected,
		ViewportId	viewportId = 'MR::ViewportId{}' )

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

Reimplemented from meshlib.mrmeshpy.VisualObject.

setGcodeSource()

None meshlib.mrmeshpy.ObjectGcode.setGcodeSource	(		self,
		std_vector_std_string	gcodeSource )

setIdleColor()

None meshlib.mrmeshpy.ObjectGcode.setIdleColor	(		self,
		Color	color )

shallowClone()

Object meshlib.mrmeshpy.ObjectGcode.shallowClone

(

self

)

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

Reimplemented from meshlib.mrmeshpy.ObjectLinesHolder.

switchFeedrateGradient()

None meshlib.mrmeshpy.ObjectGcode.switchFeedrateGradient	(		self,
		bool	isFeedrateGradientEnabled )

set drawing feedrate as gradient of brightness

TypeName()

str meshlib.mrmeshpy.ObjectGcode.TypeName ( )

static

return name of subtype for serialization purposes

Reimplemented from meshlib.mrmeshpy.ObjectLinesHolder.

typeName()

str meshlib.mrmeshpy.ObjectGcode.typeName

(

self

)

Reimplemented from meshlib.mrmeshpy.ObjectLinesHolder.

---

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

• mrmeshpy.pyi