MeshLib Python Docs
Loading...
Searching...
No Matches
mrmeshpy.ConstObjectVoxels Class Reference
Inheritance diagram for mrmeshpy.ConstObjectVoxels:

Classes

class  ConstVolumeRenderingParams
class  VolumeRenderingParams

Public Member Functions

 __init__ (self, *args, **kwargs)
int activeVoxels (self)
str className (self)
str classNameInPlural (self)
Object clone (self)
ConstVector3i dimensions (self)
ConstBox3i getActiveBounds (self)
Vector3i getCoordinateByVoxelId (self, ConstVoxelId id)
bool getDualMarchingCubes (self)
std_vector_std_string getInfoLines (self)
float getIsoValue (self)
int getMaxSurfaceVertices (self)
ConstVoxelBitSet getSelectedVoxels (self)
ConstVolumeIndexer getVolumeIndexer (self)
ConstVoxelBitSet getVolumeRenderActiveVoxels (self)
SimpleVolume getVolumeRenderingData (self)
ObjectVoxels.ConstVolumeRenderingParams getVolumeRenderingParams (self)
VoxelId getVoxelIdByCoordinate (self, ConstVector3i coord)
VoxelId getVoxelIdByPoint (self, ConstVector3f point)
ConstFloatGrid grid (self)
bool hasModel (self)
bool hasVisualRepresentation (self)
int heapBytes (self)
ConstHistogram histogram (self)
bool isVolumeRenderingEnabled (self)
bool prepareDataForVolumeRendering (self, Const_func_bool_from_float cb='{}')
Histogram recalculateHistogram (self, Const_std_optional_Vector2_float minmax, Const_func_bool_from_float cb='{}')
Mesh recalculateIsoSurface (self, float iso, Const_func_bool_from_float cb='{}')
Mesh recalculateIsoSurface (self, ConstVdbVolume volume, float iso, Const_func_bool_from_float cb='{}')
str serializeFormat (self)
Object shallowClone (self)
Mesh surface (self)
str typeName (self)
ConstVdbVolume vdbVolume (self)
ConstVector3f voxelSize (self)
Public Member Functions inherited from mrmeshpy.ConstObjectMeshHolder
 __init__ (self, *args, **kwargs)
str actualSerializeFormat (self)
float avgEdgeLen (self)
ConstUndirectedEdgeBitSet creases (self)
ConstObjectMeshData data (self)
bool flatShading (self)
std_vector_ViewportMask getAllVisualizeProperties (self)
ConstMeshTexture getAncillaryTexture (self)
ConstVertCoords2 getAncillaryUVCoords (self)
ConstColor getBordersColor (self, ConstViewportId id=...)
ConstViewportProperty_Color getBordersColorsForAllViewports (self)
float getEdgeWidth (self)
ConstColor getEdgesColor (self, ConstViewportId id=...)
ConstViewportProperty_Color getEdgesColorsForAllViewports (self)
ConstFaceColors getFacesColorMap (self)
int getModelHash (self)
float getPointSize (self)
ConstColor getPointsColor (self, ConstViewportId id=...)
ConstViewportProperty_Color getPointsColorsForAllViewports (self)
bool getRedrawFlag (self, ConstViewportMask viewportMask)
ConstUndirectedEdgeBitSet getSelectedEdges (self)
ConstColor getSelectedEdgesColor (self, ConstViewportId id=...)
ConstViewportProperty_Color getSelectedEdgesColorsForAllViewports (self)
ConstFaceBitSet getSelectedFaces (self)
ConstColor getSelectedFacesColor (self, ConstViewportId id=...)
ConstViewportProperty_Color getSelectedFacesColorsForAllViewports (self)
ConstMeshTexture getTexture (self)
ConstTexturePerFace getTexturePerFace (self)
ConstVector_MeshTexture_TextureId getTextures (self)
ConstVertCoords2 getUVCoords (self)
ConstVertColors getVertsColorMap (self)
ConstViewportMask getVisualizePropertyMask (self, ConstAnyVisualizeMaskEnum type)
bool hasAncillaryTexture (self)
bool isMeshClosed (self)
ConstMesh mesh (self)
MeshPart meshPart (self)
ConstMesh meshPtr (self)
int numComponents (self)
int numCreaseEdges (self)
int numHandles (self)
int numHoles (self)
int numSelectedEdges (self)
int numSelectedFaces (self)
int numUndirectedEdges (self)
bool sameModels (self, ConstObject other)
float selectedArea (self)
bool supportsVisualizeProperty (self, ConstAnyVisualizeMaskEnum type)
float totalArea (self)
float volume (self)
Public Member Functions inherited from mrmeshpy.ConstVisualObject
 __init__ (self, *args, **kwargs)
float getAmbientStrength (self)
ConstColor getBackColor (self, ConstViewportId viewportId=...)
ConstViewportProperty_Color getBackColorsForAllViewports (self)
Box3f getBoundingBox (self)
ColoringType getColoringType (self)
int getDirtyFlags (self)
ConstColor getFrontColor (self, bool selected=True, ConstViewportId viewportId=...)
ConstViewportProperty_Color getFrontColorsForAllViewports (self, bool selected=True)
int getGlobalAlpha (self, ConstViewportId viewportId=...)
ConstViewportProperty_unsigned_char getGlobalAlphaForAllViewports (self)
float getShininess (self)
float getSpecularStrength (self)
bool getVisualizeProperty (self, ConstAnyVisualizeMaskEnum type, ConstViewportMask viewportMask)
bool globalClippedByPlane (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
ViewportMask globalClippedByPlaneMask (self)
bool isPickable (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
None renderUi (self, ConstUiRenderParams params)
None resetDirty (self)
None resetDirtyExceptMask (self, int mask)
bool showName (self)
bool useDefaultScenePropertiesOnDeserialization (self)
Public Member Functions inherited from mrmeshpy.ConstObject
 __init__ (self, *args, **kwargs)
ConstVisualObject asType (self)
Const_std_vector_std_shared_ptr_Object_const children (self)
Object cloneTree (self)
ConstChildren constChildren (self)
ConstObject find (self, str name)
ConstObject findCommonAncestor (self, ConstObject other)
bool globalVisibility (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
ViewportMask globalVisibilityMask (self)
bool isAncestor (self, ConstObject ancestor)
bool isAncillary (self)
bool isGlobalAncillary (self)
bool isLocked (self)
bool isParentLocked (self)
bool isSelected (self)
bool isVisible (self, ConstViewportMask viewportMask='MR::ViewportMask::any()')
str name (self)
ConstObject parent (self)
None resetRedrawFlag (self)
Object shallowCloneTree (self)
Const_std_set_std_string tags (self)
ViewportMask visibilityMask (self)
AffineXf3f worldXf (self, ConstViewportId id=..., bool_output isDef=None)
ConstAffineXf3f xf (self, ConstViewportId id=..., bool_output isDef=None)
ConstViewportProperty_AffineXf3f xfsForAllViewports (self)
Public Member Functions inherited from mrmeshpy.ConstObjectChildrenHolder
 __init__ (self, *args, **kwargs)
Object getSharedPtr (self)

Static Public Member Functions

str StaticClassName ()
str StaticClassNameInPlural ()
str StaticTypeName ()
Static Public Member Functions inherited from mrmeshpy.ConstObjectMeshHolder
Box3f getWorldBox (*args, **kwargs)
Static Public Member Functions inherited from mrmeshpy.ConstVisualObject
bool render (*args, **kwargs)
None renderForPicker (*args, **kwargs)
Static Public Member Functions inherited from mrmeshpy.ConstObject
Box3f getWorldTreeBox (*args, **kwargs)

Detailed Description

Generated from:  MR::ObjectVoxels
Aliases:  ChangVoxelSelectionAction.Obj, ChangeActiveBoxAction.Obj, ChangeDualMarchingCubesAction.Obj, ChangeGridAction.Obj, ChangeIsoAction.Obj, ChangeSurfaceAction.Obj, std_shared_ptr_ChangVoxelSelectionAction_Obj, std_shared_ptr_ChangeActiveBoxAction_Obj, std_shared_ptr_ChangeDualMarchingCubesAction_Obj, std_shared_ptr_ChangeGridAction_Obj, std_shared_ptr_ChangeIsoAction_Obj, std_shared_ptr_ChangeSurfaceAction_Obj, std_shared_ptr_ObjectVoxels

This class stores information about voxels object

Constructor & Destructor Documentation

◆ __init__()

mrmeshpy.ConstObjectVoxels.__init__ ( self,
* args,
** kwargs )
__init__(self: meshlib.mrmeshpy.ConstObjectVoxels) -> None

Member Function Documentation

◆ activeVoxels()

int mrmeshpy.ConstObjectVoxels.activeVoxels ( self)
returns cached information about the number of active voxels

◆ className()

str mrmeshpy.ConstObjectVoxels.className ( self)

Reimplemented from mrmeshpy.ConstVisualObject.

◆ classNameInPlural()

str mrmeshpy.ConstObjectVoxels.classNameInPlural ( self)

Reimplemented from mrmeshpy.ConstVisualObject.

◆ clone()

Object mrmeshpy.ConstObjectVoxels.clone ( self)
clones this object only, without its children,
making new object the owner of all copied resources

Reimplemented from mrmeshpy.ConstObjectMeshHolder.

◆ dimensions()

ConstVector3i mrmeshpy.ConstObjectVoxels.dimensions ( self)
Returns dimensions of voxel objects

◆ getActiveBounds()

ConstBox3i mrmeshpy.ConstObjectVoxels.getActiveBounds ( self)
Returns active bounds (max excluded)
active bounds is box in voxel coordinates, note that voxels under (0,0,0) and voxels over (dimensions) are empty

◆ getCoordinateByVoxelId()

Vector3i mrmeshpy.ConstObjectVoxels.getCoordinateByVoxelId ( self,
ConstVoxelId id )

◆ getDualMarchingCubes()

bool mrmeshpy.ConstObjectVoxels.getDualMarchingCubes ( self)
returns true if the iso-surface is built using Dual Marching Cubes algorithm or false if using Standard Marching Cubes

◆ getInfoLines()

std_vector_std_string mrmeshpy.ConstObjectVoxels.getInfoLines ( self)
return several info lines that can better describe the object in the UI

Reimplemented from mrmeshpy.ConstVisualObject.

◆ getIsoValue()

float mrmeshpy.ConstObjectVoxels.getIsoValue ( self)
Returns current iso value

◆ getMaxSurfaceVertices()

int mrmeshpy.ConstObjectVoxels.getMaxSurfaceVertices ( self)
gets top limit on the number of vertices in the iso-surface

◆ getSelectedVoxels()

ConstVoxelBitSet mrmeshpy.ConstObjectVoxels.getSelectedVoxels ( self)

◆ getVolumeIndexer()

ConstVolumeIndexer mrmeshpy.ConstObjectVoxels.getVolumeIndexer ( self)
Returns indexer with more options

◆ getVolumeRenderActiveVoxels()

ConstVoxelBitSet mrmeshpy.ConstObjectVoxels.getVolumeRenderActiveVoxels ( self)
get active (visible) voxels

◆ getVolumeRenderingData()

SimpleVolume mrmeshpy.ConstObjectVoxels.getVolumeRenderingData ( self)
move volume rendering data to caller: basically used in RenderVolumeObject

◆ getVolumeRenderingParams()

ObjectVoxels.ConstVolumeRenderingParams mrmeshpy.ConstObjectVoxels.getVolumeRenderingParams ( self)

◆ getVoxelIdByCoordinate()

VoxelId mrmeshpy.ConstObjectVoxels.getVoxelIdByCoordinate ( self,
ConstVector3i coord )
VoxelId is numerical representation of voxel
Coordinate is {x,y,z} indices of voxels in box (base dimensions space, NOT active dimensions)
Point is local space coordinate of point in scene

◆ getVoxelIdByPoint()

VoxelId mrmeshpy.ConstObjectVoxels.getVoxelIdByPoint ( self,
ConstVector3f point )

◆ grid()

ConstFloatGrid mrmeshpy.ConstObjectVoxels.grid ( self)
Returns Float grid which contains voxels data, see more on openvdb::FloatGrid

◆ hasModel()

bool mrmeshpy.ConstObjectVoxels.hasModel ( self)
does the object have any model available (but possibly empty),
e.g. ObjectMesh has valid meshPtr() or ObjectPoints has valid pointCloudPtr()

Reimplemented from mrmeshpy.ConstObjectMeshHolder.

◆ hasVisualRepresentation()

bool mrmeshpy.ConstObjectVoxels.hasVisualRepresentation ( self)
mesh object can be seen if the mesh has at least one edge

Reimplemented from mrmeshpy.ConstObjectMeshHolder.

◆ heapBytes()

int mrmeshpy.ConstObjectVoxels.heapBytes ( self)
returns the amount of memory this object occupies on heap

Reimplemented from mrmeshpy.ConstObjectMeshHolder.

◆ histogram()

ConstHistogram mrmeshpy.ConstObjectVoxels.histogram ( self)
Returns histogram

◆ isVolumeRenderingEnabled()

bool mrmeshpy.ConstObjectVoxels.isVolumeRenderingEnabled ( self)

◆ prepareDataForVolumeRendering()

bool mrmeshpy.ConstObjectVoxels.prepareDataForVolumeRendering ( self,
Const_func_bool_from_float cb = '{}' )
prepare data for volume rendering
returns false if canceled or voxel data is empty

◆ recalculateHistogram()

Histogram mrmeshpy.ConstObjectVoxels.recalculateHistogram ( self,
Const_std_optional_Vector2_float minmax,
Const_func_bool_from_float cb = '{}' )
Calculates and returns new histogram

◆ recalculateIsoSurface() [1/2]

Mesh mrmeshpy.ConstObjectVoxels.recalculateIsoSurface ( self,
ConstVdbVolume volume,
float iso,
Const_func_bool_from_float cb = '{}' )
Same as above, but takes external volume

◆ recalculateIsoSurface() [2/2]

Mesh mrmeshpy.ConstObjectVoxels.recalculateIsoSurface ( self,
float iso,
Const_func_bool_from_float cb = '{}' )
Calculates and return new mesh or error message

◆ serializeFormat()

str mrmeshpy.ConstObjectVoxels.serializeFormat ( self)
returns overriden file extension used to serialize voxels inside this object, nullptr means SceneSettings::get( SceneSettings::StringType::VoxelsSerializeFormat )

Reimplemented from mrmeshpy.ConstObjectMeshHolder.

◆ shallowClone()

Object mrmeshpy.ConstObjectVoxels.shallowClone ( self)
clones this object only, without its children,
making new object to share resources with this object

Reimplemented from mrmeshpy.ConstObjectMeshHolder.

◆ StaticClassName()

str mrmeshpy.ConstObjectVoxels.StaticClassName ( )
static
return human readable name of subclass

Reimplemented from mrmeshpy.ConstVisualObject.

◆ StaticClassNameInPlural()

str mrmeshpy.ConstObjectVoxels.StaticClassNameInPlural ( )
static
return human readable name of subclass in plural form

Reimplemented from mrmeshpy.ConstVisualObject.

◆ StaticTypeName()

str mrmeshpy.ConstObjectVoxels.StaticTypeName ( )
static
return name of subtype for serialization purposes

Reimplemented from mrmeshpy.ConstObjectMeshHolder.

◆ surface()

Mesh mrmeshpy.ConstObjectVoxels.surface ( self)
Returns iso surface, empty if iso value is not set

◆ typeName()

str mrmeshpy.ConstObjectVoxels.typeName ( self)

Reimplemented from mrmeshpy.ConstObjectMeshHolder.

◆ vdbVolume()

ConstVdbVolume mrmeshpy.ConstObjectVoxels.vdbVolume ( self)
Return VdbVolume

◆ voxelSize()

ConstVector3f mrmeshpy.ConstObjectVoxels.voxelSize ( self)

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