MeshLib Python Docs
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Protected Attributes | List of all members
mrmeshpy.SaveSettings Class Reference
+ Inheritance diagram for mrmeshpy.SaveSettings:

Public Member Functions

None __init__ (self)
 
None __init__ (self, SaveSettings arg0)
 
None __init__ (self, bool onlyValidPoints, bool packPrimitives, VertColors colors, std_vector_Color primitiveColors, VertCoords2 uvMap, MeshTexture texture, str materialName, AffineXf3d xf, std_optional_LengthUnit lengthUnit, std_optional_Color solidColor, func_bool_from_float progress)
 
VertColors colors (self)
 
None colors (self, VertColors arg1)
 
std_optional_LengthUnit lengthUnit (self)
 
None lengthUnit (self, std_optional_LengthUnit arg1)
 
str materialName (self)
 
None materialName (self, str arg1)
 
bool onlyValidPoints (self)
 
None onlyValidPoints (self, bool arg1)
 
bool packPrimitives (self)
 
None packPrimitives (self, bool arg1)
 
std_vector_Color primitiveColors (self)
 
None primitiveColors (self, std_vector_Color arg1)
 
func_bool_from_float progress (self)
 
None progress (self, func_bool_from_float arg1)
 
std_optional_Color solidColor (self)
 
None solidColor (self, std_optional_Color arg1)
 
MeshTexture texture (self)
 
None texture (self, MeshTexture arg1)
 
VertCoords2 uvMap (self)
 
None uvMap (self, VertCoords2 arg1)
 
AffineXf3d xf (self)
 
None xf (self, AffineXf3d arg1)
 

Static Public Member Functions

None __init__ (*args, **kwargs)
 
SaveSettings operator (*args, **kwargs)
 
SaveSettings operator (*args, **kwargs)
 

Static Protected Attributes

typing _offsetof_colors = 8
 
typing _offsetof_lengthUnit = 80
 
typing _offsetof_materialName = 40
 
typing _offsetof_onlyValidPoints = 0
 
typing _offsetof_packPrimitives = 1
 
typing _offsetof_primitiveColors = 16
 
typing _offsetof_progress = 96
 
typing _offsetof_solidColor = 88
 
typing _offsetof_texture = 32
 
typing _offsetof_uvMap = 24
 
typing _offsetof_xf = 72
 

Detailed Description

Generated from:  MR::SaveSettings

determines how to save points/lines/mesh

Constructor & Destructor Documentation

◆ __init__() [1/4]

None mrmeshpy.SaveSettings.__init__ ( * args,
** kwargs )
static

Reimplemented in mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.PointsSave.CtmSavePointsOptions, mrmeshpy.PointsSave.CtmSavePointsOptions, and mrmeshpy.PointsSave.CtmSavePointsOptions.

◆ __init__() [2/4]

None mrmeshpy.SaveSettings.__init__ ( self)

Reimplemented in mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.PointsSave.CtmSavePointsOptions, mrmeshpy.PointsSave.CtmSavePointsOptions, and mrmeshpy.PointsSave.CtmSavePointsOptions.

◆ __init__() [3/4]

None mrmeshpy.SaveSettings.__init__ ( self,
SaveSettings arg0 ) 
Implicit copy constructor.

Reimplemented in mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.PointsSave.CtmSavePointsOptions, mrmeshpy.PointsSave.CtmSavePointsOptions, and mrmeshpy.PointsSave.CtmSavePointsOptions.

◆ __init__() [4/4]

None mrmeshpy.SaveSettings.__init__ ( self,
bool onlyValidPoints,
bool packPrimitives,
VertColors colors,
std_vector_Color primitiveColors,
VertCoords2 uvMap,
MeshTexture texture,
str materialName,
AffineXf3d xf,
std_optional_LengthUnit lengthUnit,
std_optional_Color solidColor,
func_bool_from_float progress ) 
Implicit aggregate constructor.

Reimplemented in mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.PointsSave.CtmSavePointsOptions, mrmeshpy.PointsSave.CtmSavePointsOptions, and mrmeshpy.PointsSave.CtmSavePointsOptions.

Member Function Documentation

◆ colors() [1/2]

VertColors mrmeshpy.SaveSettings.colors ( self) 
optional per-vertex color to save with the geometry

◆ colors() [2/2]

None mrmeshpy.SaveSettings.colors ( self,
VertColors arg1 )

◆ lengthUnit() [1/2]

std_optional_LengthUnit mrmeshpy.SaveSettings.lengthUnit ( self) 
units of input coordinates and transformation, to be serialized if the format supports it

◆ lengthUnit() [2/2]

None mrmeshpy.SaveSettings.lengthUnit ( self,
std_optional_LengthUnit arg1 )

◆ materialName() [1/2]

str mrmeshpy.SaveSettings.materialName ( self) 
used to save texture and material in some formats (obj)

◆ materialName() [2/2]

None mrmeshpy.SaveSettings.materialName ( self,
str arg1 )

◆ onlyValidPoints() [1/2]

bool mrmeshpy.SaveSettings.onlyValidPoints ( self) 
true - save valid points/vertices only (pack them);
false - save all points/vertices preserving their indices

◆ onlyValidPoints() [2/2]

None mrmeshpy.SaveSettings.onlyValidPoints ( self,
bool arg1 )

◆ operator() [1/2]

SaveSettings mrmeshpy.SaveSettings.operator ( * args,
** kwargs )
static

Reimplemented in mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.PointsSave.CtmSavePointsOptions, and mrmeshpy.PointsSave.CtmSavePointsOptions.

◆ operator() [2/2]

SaveSettings mrmeshpy.SaveSettings.operator ( * args,
** kwargs )
static

Reimplemented in mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.MeshSave.CtmSaveOptions, mrmeshpy.PointsSave.CtmSavePointsOptions, and mrmeshpy.PointsSave.CtmSavePointsOptions.

◆ packPrimitives() [1/2]

bool mrmeshpy.SaveSettings.packPrimitives ( self) 
whether to allow packing or shuffling of primitives (triangles in meshes or edges in polylines);
if packPrimitives=true, then ids of invalid primitives are reused by valid primitives
and higher compression (in .ctm format) can be reached if the order of triangles is changed;
if packPrimitives=false then all primitives maintain their ids, and invalid primitives are saved with all vertex ids equal to zero;
currently this flag affects the saving in .ctm and .ply formats only

◆ packPrimitives() [2/2]

None mrmeshpy.SaveSettings.packPrimitives ( self,
bool arg1 )

◆ primitiveColors() [1/2]

std_vector_Color mrmeshpy.SaveSettings.primitiveColors ( self) 
per-face colors for meshes, per-undirected-edge colors for polylines, unused for point clouds and other

◆ primitiveColors() [2/2]

None mrmeshpy.SaveSettings.primitiveColors ( self,
std_vector_Color arg1 )

◆ progress() [1/2]

func_bool_from_float mrmeshpy.SaveSettings.progress ( self) 
to report save progress and cancel saving if user desires

◆ progress() [2/2]

None mrmeshpy.SaveSettings.progress ( self,
func_bool_from_float arg1 )

◆ solidColor() [1/2]

std_optional_Color mrmeshpy.SaveSettings.solidColor ( self) 
the color of whole object

◆ solidColor() [2/2]

None mrmeshpy.SaveSettings.solidColor ( self,
std_optional_Color arg1 )

◆ texture() [1/2]

MeshTexture mrmeshpy.SaveSettings.texture ( self) 
optional texture to save with the geometry

◆ texture() [2/2]

None mrmeshpy.SaveSettings.texture ( self,
MeshTexture arg1 )

◆ uvMap() [1/2]

VertCoords2 mrmeshpy.SaveSettings.uvMap ( self) 
optional per-vertex uv coordinate to save with the geometry

◆ uvMap() [2/2]

None mrmeshpy.SaveSettings.uvMap ( self,
VertCoords2 arg1 )

◆ xf() [1/2]

AffineXf3d mrmeshpy.SaveSettings.xf ( self) 
this transformation can optionally be applied to all vertices (points) of saved object

◆ xf() [2/2]

None mrmeshpy.SaveSettings.xf ( self,
AffineXf3d arg1 )

Member Data Documentation

◆ _offsetof_colors

typing mrmeshpy.SaveSettings._offsetof_colors = 8
staticprotected

◆ _offsetof_lengthUnit

typing mrmeshpy.SaveSettings._offsetof_lengthUnit = 80
staticprotected

◆ _offsetof_materialName

typing mrmeshpy.SaveSettings._offsetof_materialName = 40
staticprotected

◆ _offsetof_onlyValidPoints

typing mrmeshpy.SaveSettings._offsetof_onlyValidPoints = 0
staticprotected

◆ _offsetof_packPrimitives

typing mrmeshpy.SaveSettings._offsetof_packPrimitives = 1
staticprotected

◆ _offsetof_primitiveColors

typing mrmeshpy.SaveSettings._offsetof_primitiveColors = 16
staticprotected

◆ _offsetof_progress

typing mrmeshpy.SaveSettings._offsetof_progress = 96
staticprotected

◆ _offsetof_solidColor

typing mrmeshpy.SaveSettings._offsetof_solidColor = 88
staticprotected

◆ _offsetof_texture

typing mrmeshpy.SaveSettings._offsetof_texture = 32
staticprotected

◆ _offsetof_uvMap

typing mrmeshpy.SaveSettings._offsetof_uvMap = 24
staticprotected

◆ _offsetof_xf

typing mrmeshpy.SaveSettings._offsetof_xf = 72
staticprotected
The documentation for this class was generated from the following file: