MeshLib Java Docs
Loading...
Searching...
No Matches
meshlib.voxelssave.SavingSettings Class Reference
Inheritance diagram for meshlib.voxelssave.SavingSettings:

Public Member Functions

 SavingSettings (java.lang.foreign.MemorySegment ptr, boolean owned, java.lang.Object owner)
 SavingSettings ()
 SavingSettings (java.lang.String path, java.lang.String format, meshlib.SlicePlane slicePlane, meshlib.std_function_bool_from_float cb)
 SavingSettings (meshlib.voxelssave.SavingSettings _other)
meshlib.voxelssave.SavingSettings assignFromAnother (meshlib.voxelssave.SavingSettings _other)
meshlib.std_filesystem_path path ()
void setPath (java.lang.String value)
meshlib.std_string format ()
void setFormat (java.lang.String value)
meshlib.SlicePlane slicePlane ()
void setSlicePlane (meshlib.SlicePlane value)
meshlib.std_function_bool_from_float cb ()
void setCb (meshlib.std_function_bool_from_float value)
Public Member Functions inherited from meshlib.CppObject
final java.lang.foreign.MemorySegment rawPointer ()
final boolean isOwned ()
final void close ()
final java.lang.foreign.MemorySegment release ()

Additional Inherited Members

Protected Member Functions inherited from meshlib.CppObject
 CppObject (java.lang.foreign.MemorySegment ptr, java.util.function.Consumer< java.lang.foreign.MemorySegment > destroy, java.lang.Object owner)

Detailed Description

stores together all data for save voxel object as a group of images Generated from class MR::VoxelsSave::SavingSettings.

Instances created here own their C++ objects, see CppObject.

Constructor & Destructor Documentation

◆ SavingSettings() [1/4]

meshlib.voxelssave.SavingSettings.SavingSettings ( java.lang.foreign.MemorySegment ptr,
boolean owned,
java.lang.Object owner )

Wraps a pointer from the C bindings. If owned, the object is destroyed when the wrapper dies. owner is kept alive as long as this wrapper is. Not for normal use.

◆ SavingSettings() [2/4]

meshlib.voxelssave.SavingSettings.SavingSettings ( )

Constructs an empty (default-constructed) instance.

Calls MR_VoxelsSave_SavingSettings_DefaultConstruct().

◆ SavingSettings() [3/4]

meshlib.voxelssave.SavingSettings.SavingSettings ( java.lang.String path,
java.lang.String format,
meshlib.SlicePlane slicePlane,
meshlib.std_function_bool_from_float cb )

Constructs MR::VoxelsSave::SavingSettings elementwise. The reference to the parameter path might be preserved in the constructed object. The reference to the parameter format might be preserved in the constructed object. The reference to the parameter slicePlane might be preserved in the constructed object. The reference to the parameter cb might be preserved in the constructed object.

Calls MR_VoxelsSave_SavingSettings_ConstructFrom().

◆ SavingSettings() [4/4]

meshlib.voxelssave.SavingSettings.SavingSettings ( meshlib.voxelssave.SavingSettings _other)

Generated from constructor MR::VoxelsSave::SavingSettings::SavingSettings. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object.

Calls MR_VoxelsSave_SavingSettings_ConstructFromAnother().

Member Function Documentation

◆ assignFromAnother()

meshlib.voxelssave.SavingSettings meshlib.voxelssave.SavingSettings.assignFromAnother ( meshlib.voxelssave.SavingSettings _other)

Generated from method MR::VoxelsSave::SavingSettings::operator=. The reference to things referred to by the parameter _other (if any) might be preserved in this object.

Calls MR_VoxelsSave_SavingSettings_AssignFromAnother().

◆ cb()

meshlib.std_function_bool_from_float meshlib.voxelssave.SavingSettings.cb ( )

Callback reporting progress Returns a pointer to a member variable of class MR::VoxelsSave::SavingSettings named cb. The reference to this object might be preserved as the return value.

Calls MR_VoxelsSave_SavingSettings_Get_cb().

◆ format()

meshlib.std_string meshlib.voxelssave.SavingSettings.format ( )

format for file names, you should specify a placeholder for number and extension, eg "slice_{0:0{1}}.tif" Returns a pointer to a member variable of class MR::VoxelsSave::SavingSettings named format. The reference to this object might be preserved as the return value.

Calls MR_VoxelsSave_SavingSettings_Get_format().

◆ path()

meshlib.std_filesystem_path meshlib.voxelssave.SavingSettings.path ( )

path to directory where you want to save images Returns a pointer to a member variable of class MR::VoxelsSave::SavingSettings named path. The reference to this object might be preserved as the return value.

Calls MR_VoxelsSave_SavingSettings_Get_path().

◆ setCb()

void meshlib.voxelssave.SavingSettings.setCb ( meshlib.std_function_bool_from_float value)

Callback reporting progress Modifies a member variable of class MR::VoxelsSave::SavingSettings named cb. The reference to the parameter value might be preserved in this object in element cb.

Calls MR_VoxelsSave_SavingSettings_Set_cb().

◆ setFormat()

void meshlib.voxelssave.SavingSettings.setFormat ( java.lang.String value)

format for file names, you should specify a placeholder for number and extension, eg "slice_{0:0{1}}.tif" Modifies a member variable of class MR::VoxelsSave::SavingSettings named format. The reference to the parameter value might be preserved in this object in element format.

Calls MR_VoxelsSave_SavingSettings_Set_format().

◆ setPath()

void meshlib.voxelssave.SavingSettings.setPath ( java.lang.String value)

path to directory where you want to save images Modifies a member variable of class MR::VoxelsSave::SavingSettings named path. The reference to the parameter value might be preserved in this object in element path.

Calls MR_VoxelsSave_SavingSettings_Set_path().

◆ setSlicePlane()

void meshlib.voxelssave.SavingSettings.setSlicePlane ( meshlib.SlicePlane value)

Plane which the object is sliced by. XY, XZ, or YZ Modifies a member variable of class MR::VoxelsSave::SavingSettings named slicePlane. The reference to the parameter value might be preserved in this object in element slicePlane.

Calls MR_VoxelsSave_SavingSettings_Set_slicePlane().

◆ slicePlane()

meshlib.SlicePlane meshlib.voxelssave.SavingSettings.slicePlane ( )

Plane which the object is sliced by. XY, XZ, or YZ Returns a pointer to a member variable of class MR::VoxelsSave::SavingSettings named slicePlane. The reference to this object might be preserved as the return value.

Calls MR_VoxelsSave_SavingSettings_Get_slicePlane().


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