Static Public Member Functions | |
| str | StaticClassName () |
| str | StaticClassNameInPlural () |
| str | StaticTypeName () |
| Box3f | getWorldBox (*args, **kwargs) |
| bool | render (*args, **kwargs) |
| None | renderForPicker (*args, **kwargs) |
| Static Public Member Functions inherited from mrmeshpy.ConstObject | |
| Box3f | getWorldTreeBox (*args, **kwargs) |
Generated from: MR::VisualObject Aliases: ChangeColoringType.Obj, ChangeObjectColorAction.Obj, ChangeVisualizePropertyAction.Obj, std_shared_ptr_VisualObject Visual Object
| mrmeshpy.ConstVisualObject.__init__ | ( | self, | |
| * | args, | ||
| ** | kwargs ) |
__init__(self: meshlib.mrmeshpy.ConstVisualObject) -> None
| str mrmeshpy.ConstVisualObject.className | ( | self | ) |
Reimplemented from mrmeshpy.ConstObject.
Reimplemented in mrmeshpy.ConstAngleMeasurementObject, mrmeshpy.ConstCircleObject, mrmeshpy.ConstConeObject, mrmeshpy.ConstCylinderObject, mrmeshpy.ConstDistanceMeasurementObject, mrmeshpy.ConstFeatureObject, mrmeshpy.ConstLineObject, mrmeshpy.ConstObjectDistanceMap, mrmeshpy.ConstObjectGcode, mrmeshpy.ConstObjectLines, mrmeshpy.ConstObjectMesh, mrmeshpy.ConstObjectPoints, mrmeshpy.ConstObjectVoxels, mrmeshpy.ConstPlaneObject, mrmeshpy.ConstPointMeasurementObject, mrmeshpy.ConstPointObject, mrmeshpy.ConstRadiusMeasurementObject, and mrmeshpy.ConstSphereObject.
| str mrmeshpy.ConstVisualObject.classNameInPlural | ( | self | ) |
Reimplemented from mrmeshpy.ConstObject.
Reimplemented in mrmeshpy.ConstAngleMeasurementObject, mrmeshpy.ConstCircleObject, mrmeshpy.ConstConeObject, mrmeshpy.ConstCylinderObject, mrmeshpy.ConstDistanceMeasurementObject, mrmeshpy.ConstFeatureObject, mrmeshpy.ConstLineObject, mrmeshpy.ConstObjectDistanceMap, mrmeshpy.ConstObjectGcode, mrmeshpy.ConstObjectLines, mrmeshpy.ConstObjectMesh, mrmeshpy.ConstObjectPoints, mrmeshpy.ConstObjectVoxels, mrmeshpy.ConstPlaneObject, mrmeshpy.ConstPointMeasurementObject, mrmeshpy.ConstPointObject, mrmeshpy.ConstRadiusMeasurementObject, and mrmeshpy.ConstSphereObject.
| Object mrmeshpy.ConstVisualObject.clone | ( | self | ) |
clones this object only, without its children, making new object the owner of all copied resources
Reimplemented from mrmeshpy.ConstObject.
Reimplemented in mrmeshpy.ConstAngleMeasurementObject, mrmeshpy.ConstCircleObject, mrmeshpy.ConstConeObject, mrmeshpy.ConstCylinderObject, mrmeshpy.ConstDistanceMeasurementObject, mrmeshpy.ConstLineObject, mrmeshpy.ConstObjectDistanceMap, mrmeshpy.ConstObjectGcode, mrmeshpy.ConstObjectLabel, mrmeshpy.ConstObjectLines, mrmeshpy.ConstObjectLinesHolder, mrmeshpy.ConstObjectMesh, mrmeshpy.ConstObjectMeshHolder, mrmeshpy.ConstObjectPoints, mrmeshpy.ConstObjectPointsHolder, mrmeshpy.ConstObjectVoxels, mrmeshpy.ConstPlaneObject, mrmeshpy.ConstPointMeasurementObject, mrmeshpy.ConstPointObject, mrmeshpy.ConstRadiusMeasurementObject, and mrmeshpy.ConstSphereObject.
| std_vector_ViewportMask mrmeshpy.ConstVisualObject.getAllVisualizeProperties | ( | self | ) |
get all visualize properties masks
Reimplemented in mrmeshpy.ConstAddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter, mrmeshpy.ConstAddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_angle_DimensionsVisualizePropertyType_length, mrmeshpy.ConstAddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_length, mrmeshpy.ConstFeatureObject, mrmeshpy.ConstObjectLabel, mrmeshpy.ConstObjectLinesHolder, mrmeshpy.ConstObjectMeshHolder, mrmeshpy.ConstObjectPointsHolder, and mrmeshpy.ConstPointMeasurementObject.
| float mrmeshpy.ConstVisualObject.getAmbientStrength | ( | self | ) |
returns intensity of non-directional light
| ConstColor mrmeshpy.ConstVisualObject.getBackColor | ( | self, | |
| ConstViewportId | viewportId = ... ) |
returns backward color of object in given viewport
| ConstViewportProperty_Color mrmeshpy.ConstVisualObject.getBackColorsForAllViewports | ( | self | ) |
returns backward color of object in all viewports
| Box3f mrmeshpy.ConstVisualObject.getBoundingBox | ( | self | ) |
returns cached bounding box of this object in local coordinates
| ColoringType mrmeshpy.ConstVisualObject.getColoringType | ( | self | ) |
returns the current coloring mode of the object
| int mrmeshpy.ConstVisualObject.getDirtyFlags | ( | self | ) |
returns current dirty flags for the object
| ConstColor mrmeshpy.ConstVisualObject.getFrontColor | ( | self, | |
| bool | selected = True, | ||
| ConstViewportId | viewportId = ... ) |
returns color of object when it is selected/not-selected (depending on argument) in given viewport
| ConstViewportProperty_Color mrmeshpy.ConstVisualObject.getFrontColorsForAllViewports | ( | self, | |
| bool | selected = True ) |
returns color of object when it is selected/not-selected (depending on argument) in all viewports
| int mrmeshpy.ConstVisualObject.getGlobalAlpha | ( | self, | |
| ConstViewportId | viewportId = ... ) |
returns global transparency alpha of object in given viewport
| ConstViewportProperty_unsigned_char mrmeshpy.ConstVisualObject.getGlobalAlphaForAllViewports | ( | self | ) |
returns global transparency alpha of object in all viewports
| std_vector_std_string mrmeshpy.ConstVisualObject.getInfoLines | ( | self | ) |
return several info lines that can better describe the object in the UI
Reimplemented from mrmeshpy.ConstObject.
Reimplemented in mrmeshpy.ConstAngleMeasurementObject, mrmeshpy.ConstDistanceMeasurementObject, mrmeshpy.ConstObjectDistanceMap, mrmeshpy.ConstObjectGcode, mrmeshpy.ConstObjectLines, mrmeshpy.ConstObjectMesh, mrmeshpy.ConstObjectPoints, mrmeshpy.ConstObjectVoxels, and mrmeshpy.ConstRadiusMeasurementObject.
| bool mrmeshpy.ConstVisualObject.getRedrawFlag | ( | self, | |
| ConstViewportMask | viewportMask ) |
returns true if the object must be redrawn (due to dirty flags) in one of specified viewports
Reimplemented from mrmeshpy.ConstObject.
Reimplemented in mrmeshpy.ConstObjectMeshHolder.
| float mrmeshpy.ConstVisualObject.getShininess | ( | self | ) |
returns the current shininess visual value
| float mrmeshpy.ConstVisualObject.getSpecularStrength | ( | self | ) |
returns intensity of reflections
| bool mrmeshpy.ConstVisualObject.getVisualizeProperty | ( | self, | |
| ConstAnyVisualizeMaskEnum | type, | ||
| ConstViewportMask | viewportMask ) |
returns true if the property is set at least in one viewport specified by the mask
| ConstViewportMask mrmeshpy.ConstVisualObject.getVisualizePropertyMask | ( | self, | |
| ConstAnyVisualizeMaskEnum | type ) |
returns mask of viewports where given property is set
Reimplemented in mrmeshpy.ConstAddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter, mrmeshpy.ConstAddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_angle_DimensionsVisualizePropertyType_length, mrmeshpy.ConstAddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_length, mrmeshpy.ConstFeatureObject, mrmeshpy.ConstObjectLabel, mrmeshpy.ConstObjectLinesHolder, mrmeshpy.ConstObjectMeshHolder, mrmeshpy.ConstObjectPointsHolder, and mrmeshpy.ConstPointMeasurementObject.
|
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.ConstObject.
Reimplemented in mrmeshpy.ConstObjectLabel, mrmeshpy.ConstObjectLinesHolder, mrmeshpy.ConstObjectMeshHolder, and mrmeshpy.ConstObjectPointsHolder.
| bool mrmeshpy.ConstVisualObject.globalClippedByPlane | ( | self, | |
| ConstViewportMask | viewportMask = 'MR::ViewportMask::any()' ) |
returns true if this object or any of its parents is clipped by plane in any of given viewports
| ViewportMask mrmeshpy.ConstVisualObject.globalClippedByPlaneMask | ( | self | ) |
returns all viewports where this object or any of its parents is clipped by plane
| int mrmeshpy.ConstVisualObject.heapBytes | ( | self | ) |
returns the amount of memory this object occupies on heap
Reimplemented from mrmeshpy.ConstObject.
Reimplemented in mrmeshpy.ConstObjectDistanceMap, mrmeshpy.ConstObjectGcode, mrmeshpy.ConstObjectLabel, mrmeshpy.ConstObjectLinesHolder, mrmeshpy.ConstObjectMeshHolder, mrmeshpy.ConstObjectPointsHolder, and mrmeshpy.ConstObjectVoxels.
| bool mrmeshpy.ConstVisualObject.isPickable | ( | self, | |
| ConstViewportMask | viewportMask = 'MR::ViewportMask::any()' ) |
whether the object can be picked (by mouse) in any of given viewports
|
static |
draws this object for visualization Returns true if something was drawn.
|
static |
draws this object for picking
| None mrmeshpy.ConstVisualObject.renderUi | ( | self, | |
| ConstUiRenderParams | params ) |
draws this object for 2d UI
| None mrmeshpy.ConstVisualObject.resetDirty | ( | self | ) |
resets all dirty flags (except for cache flags that will be reset automatically on cache update)
| None mrmeshpy.ConstVisualObject.resetDirtyExceptMask | ( | self, | |
| int | mask ) |
reset dirty flags without some specific bits (useful for lazy normals update)
| Object mrmeshpy.ConstVisualObject.shallowClone | ( | self | ) |
clones this object only, without its children, making new object to share resources with this object
Reimplemented from mrmeshpy.ConstObject.
Reimplemented in mrmeshpy.ConstAngleMeasurementObject, mrmeshpy.ConstCircleObject, mrmeshpy.ConstConeObject, mrmeshpy.ConstCylinderObject, mrmeshpy.ConstDistanceMeasurementObject, mrmeshpy.ConstLineObject, mrmeshpy.ConstObjectDistanceMap, mrmeshpy.ConstObjectGcode, mrmeshpy.ConstObjectLabel, mrmeshpy.ConstObjectLines, mrmeshpy.ConstObjectLinesHolder, mrmeshpy.ConstObjectMesh, mrmeshpy.ConstObjectMeshHolder, mrmeshpy.ConstObjectPoints, mrmeshpy.ConstObjectPointsHolder, mrmeshpy.ConstObjectVoxels, mrmeshpy.ConstPlaneObject, mrmeshpy.ConstPointMeasurementObject, mrmeshpy.ConstPointObject, mrmeshpy.ConstRadiusMeasurementObject, and mrmeshpy.ConstSphereObject.
| bool mrmeshpy.ConstVisualObject.showName | ( | self | ) |
returns whether object name is shown in any viewport
Reimplemented in mrmeshpy.VisualObject, and mrmeshpy.VisualObject.
|
static |
return human readable name of subclass
Reimplemented from mrmeshpy.ConstObject.
Reimplemented in mrmeshpy.ConstAngleMeasurementObject, mrmeshpy.ConstCircleObject, mrmeshpy.ConstConeObject, mrmeshpy.ConstCylinderObject, mrmeshpy.ConstDistanceMeasurementObject, mrmeshpy.ConstFeatureObject, mrmeshpy.ConstLineObject, mrmeshpy.ConstObjectDistanceMap, mrmeshpy.ConstObjectGcode, mrmeshpy.ConstObjectLines, mrmeshpy.ConstObjectMesh, mrmeshpy.ConstObjectPoints, mrmeshpy.ConstObjectVoxels, mrmeshpy.ConstPlaneObject, mrmeshpy.ConstPointMeasurementObject, mrmeshpy.ConstPointObject, mrmeshpy.ConstRadiusMeasurementObject, and mrmeshpy.ConstSphereObject.
|
static |
return human readable name of subclass in plural form
Reimplemented from mrmeshpy.ConstObject.
Reimplemented in mrmeshpy.ConstAngleMeasurementObject, mrmeshpy.ConstCircleObject, mrmeshpy.ConstConeObject, mrmeshpy.ConstCylinderObject, mrmeshpy.ConstDistanceMeasurementObject, mrmeshpy.ConstFeatureObject, mrmeshpy.ConstLineObject, mrmeshpy.ConstObjectDistanceMap, mrmeshpy.ConstObjectGcode, mrmeshpy.ConstObjectLines, mrmeshpy.ConstObjectMesh, mrmeshpy.ConstObjectPoints, mrmeshpy.ConstObjectVoxels, mrmeshpy.ConstPlaneObject, mrmeshpy.ConstPointMeasurementObject, mrmeshpy.ConstPointObject, mrmeshpy.ConstRadiusMeasurementObject, and mrmeshpy.ConstSphereObject.
|
static |
return name of subtype for serialization purposes
Reimplemented from mrmeshpy.ConstObject.
Reimplemented in mrmeshpy.ConstAngleMeasurementObject, mrmeshpy.ConstCircleObject, mrmeshpy.ConstConeObject, mrmeshpy.ConstCylinderObject, mrmeshpy.ConstDistanceMeasurementObject, mrmeshpy.ConstFeatureObject, mrmeshpy.ConstLineObject, mrmeshpy.ConstObjectDistanceMap, mrmeshpy.ConstObjectGcode, mrmeshpy.ConstObjectLabel, mrmeshpy.ConstObjectLines, mrmeshpy.ConstObjectLinesHolder, mrmeshpy.ConstObjectMesh, mrmeshpy.ConstObjectMeshHolder, mrmeshpy.ConstObjectPoints, mrmeshpy.ConstObjectPointsHolder, mrmeshpy.ConstObjectVoxels, mrmeshpy.ConstPlaneObject, mrmeshpy.ConstPointMeasurementObject, mrmeshpy.ConstPointObject, mrmeshpy.ConstRadiusMeasurementObject, and mrmeshpy.ConstSphereObject.
| bool mrmeshpy.ConstVisualObject.supportsVisualizeProperty | ( | self, | |
| ConstAnyVisualizeMaskEnum | type ) |
Returns true if this class supports the property `type`. Otherwise passing it to the functions below is illegal.
Reimplemented in mrmeshpy.ConstAddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter, mrmeshpy.ConstAddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_angle_DimensionsVisualizePropertyType_length, mrmeshpy.ConstAddVisualProperties_FeatureObject_DimensionsVisualizePropertyType_diameter_DimensionsVisualizePropertyType_length, mrmeshpy.ConstFeatureObject, mrmeshpy.ConstObjectLinesHolder, mrmeshpy.ConstObjectMeshHolder, mrmeshpy.ConstObjectPointsHolder, and mrmeshpy.ConstPointMeasurementObject.
| str mrmeshpy.ConstVisualObject.typeName | ( | self | ) |
Reimplemented from mrmeshpy.ConstObject.
Reimplemented in mrmeshpy.ConstAngleMeasurementObject, mrmeshpy.ConstCircleObject, mrmeshpy.ConstConeObject, mrmeshpy.ConstCylinderObject, mrmeshpy.ConstDistanceMeasurementObject, mrmeshpy.ConstFeatureObject, mrmeshpy.ConstLineObject, mrmeshpy.ConstObjectDistanceMap, mrmeshpy.ConstObjectGcode, mrmeshpy.ConstObjectLabel, mrmeshpy.ConstObjectLines, mrmeshpy.ConstObjectLinesHolder, mrmeshpy.ConstObjectMesh, mrmeshpy.ConstObjectMeshHolder, mrmeshpy.ConstObjectPoints, mrmeshpy.ConstObjectPointsHolder, mrmeshpy.ConstObjectVoxels, mrmeshpy.ConstPlaneObject, mrmeshpy.ConstPointMeasurementObject, mrmeshpy.ConstPointObject, mrmeshpy.ConstRadiusMeasurementObject, and mrmeshpy.ConstSphereObject.
| bool mrmeshpy.ConstVisualObject.useDefaultScenePropertiesOnDeserialization | ( | self | ) |
whether the scene-related properties should get their values from SceneColors and SceneSettings instances rather than from the input data on deserialization