MeshLib Rust Docs
Loading...
Searching...
No Matches
meshlib::voxels_save::SavingSettings Struct Reference
Inheritance diagram for meshlib::voxels_save::SavingSettings:

Public Member Functions

auto assign_from_another (_other:&meshlib::voxels_save::SavingSettings) -> &mut meshlib::voxels_save::SavingSettings
auto path () const -> &meshlib::std_filesystem_path
auto path_mut () -> &mut meshlib::std_filesystem_path
void set_path (value:&str)
auto format () const -> &meshlib::std_string
auto format_mut () -> &mut meshlib::std_string
void set_format (value:&str)
auto slice_plane () const -> &meshlib::SlicePlane
auto slice_plane_mut () -> &mut meshlib::SlicePlane
void set_slice_plane (value:meshlib::SlicePlane)
auto cb () const -> &meshlib::std_function_bool_from_float
auto cb_mut () -> &mut meshlib::std_function_bool_from_float
void set_cb (value:&meshlib::std_function_bool_from_float)

Static Public Member Functions

static auto new () -> meshlib::Owned< meshlib::voxels_save::SavingSettings >
static auto construct_from (path:&str, format:&str, slicePlane:meshlib::SlicePlane, cb:&meshlib::std_function_bool_from_float) -> meshlib::Owned< meshlib::voxels_save::SavingSettings >
static auto construct_from_another (_other:&meshlib::voxels_save::SavingSettings) -> meshlib::Owned< meshlib::voxels_save::SavingSettings >
Static Public Member Functions inherited from meshlib::CppClass
static void destroy (ptr:*mut Self)
Static Public Member Functions inherited from meshlib::CppCopy
static auto copy (ptr:*const Self) -> *mut Self

Detailed Description

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

Generated from class MR::VoxelsSave::SavingSettings. Heap-allocated instances are held in Owned<SavingSettings>.

Member Function Documentation

◆ assign_from_another()

auto meshlib::voxels_save::SavingSettings::assign_from_another ( _other:&meshlib::voxels_save::SavingSettings ) -> &mut meshlib::voxels_save::SavingSettings

Generated from method MR::VoxelsSave::SavingSettings::operator=.

Calls MR_VoxelsSave_SavingSettings_AssignFromAnother(). The reference to things referred to by the parameter _other (if any) might be preserved in this object.

◆ cb()

auto meshlib::voxels_save::SavingSettings::cb ( ) const -> &meshlib::std_function_bool_from_float

Callback reporting progress Returns a pointer to a member variable of class MR::VoxelsSave::SavingSettings named cb.

Calls MR_VoxelsSave_SavingSettings_Get_cb(). The reference to this object might be preserved as the return value.

◆ cb_mut()

auto meshlib::voxels_save::SavingSettings::cb_mut ( ) -> &mut meshlib::std_function_bool_from_float

Callback reporting progress Returns a mutable pointer to a member variable of class MR::VoxelsSave::SavingSettings named cb.

Calls MR_VoxelsSave_SavingSettings_GetMutable_cb(). The reference to this object might be preserved as the return value.

◆ construct_from()

auto meshlib::voxels_save::SavingSettings::construct_from ( path:& str,
format:& str,
slicePlane:meshlib::SlicePlane ,
cb:&meshlib::std_function_bool_from_float  ) -> meshlib::Owned< meshlib::voxels_save::SavingSettings >
static

Constructs MR::VoxelsSave::SavingSettings elementwise.

Calls MR_VoxelsSave_SavingSettings_ConstructFrom(). 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.

◆ construct_from_another()

auto meshlib::voxels_save::SavingSettings::construct_from_another ( _other:&meshlib::voxels_save::SavingSettings ) -> meshlib::Owned< meshlib::voxels_save::SavingSettings >
static

Generated from constructor MR::VoxelsSave::SavingSettings::SavingSettings.

Calls MR_VoxelsSave_SavingSettings_ConstructFromAnother(). The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object.

◆ format()

auto meshlib::voxels_save::SavingSettings::format ( ) const -> &meshlib::std_string

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.

Calls MR_VoxelsSave_SavingSettings_Get_format(). The reference to this object might be preserved as the return value.

◆ format_mut()

auto meshlib::voxels_save::SavingSettings::format_mut ( ) -> &mut meshlib::std_string

format for file names, you should specify a placeholder for number and extension, eg "slice_{0:0{1}}.tif" Returns a mutable pointer to a member variable of class MR::VoxelsSave::SavingSettings named format.

Calls MR_VoxelsSave_SavingSettings_GetMutable_format(). The reference to this object might be preserved as the return value.

◆ new()

auto meshlib::voxels_save::SavingSettings::new ( ) -> meshlib::Owned< meshlib::voxels_save::SavingSettings >
static

Constructs an empty (default-constructed) instance.

Calls MR_VoxelsSave_SavingSettings_DefaultConstruct().

◆ path()

auto meshlib::voxels_save::SavingSettings::path ( ) const -> &meshlib::std_filesystem_path

path to directory where you want to save images Returns a pointer to a member variable of class MR::VoxelsSave::SavingSettings named path.

Calls MR_VoxelsSave_SavingSettings_Get_path(). The reference to this object might be preserved as the return value.

◆ path_mut()

auto meshlib::voxels_save::SavingSettings::path_mut ( ) -> &mut meshlib::std_filesystem_path

path to directory where you want to save images Returns a mutable pointer to a member variable of class MR::VoxelsSave::SavingSettings named path.

Calls MR_VoxelsSave_SavingSettings_GetMutable_path(). The reference to this object might be preserved as the return value.

◆ set_cb()

void meshlib::voxels_save::SavingSettings::set_cb ( value:&meshlib::std_function_bool_from_float )

Callback reporting progress Modifies a member variable of class MR::VoxelsSave::SavingSettings named cb.

Calls MR_VoxelsSave_SavingSettings_Set_cb(). The reference to the parameter value might be preserved in this object in element cb.

◆ set_format()

void meshlib::voxels_save::SavingSettings::set_format ( value:& str)

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.

Calls MR_VoxelsSave_SavingSettings_Set_format(). The reference to the parameter value might be preserved in this object in element format.

◆ set_path()

void meshlib::voxels_save::SavingSettings::set_path ( value:& str)

path to directory where you want to save images Modifies a member variable of class MR::VoxelsSave::SavingSettings named path.

Calls MR_VoxelsSave_SavingSettings_Set_path(). The reference to the parameter value might be preserved in this object in element path.

◆ set_slice_plane()

void meshlib::voxels_save::SavingSettings::set_slice_plane ( value:meshlib::SlicePlane )

Plane which the object is sliced by. XY, XZ, or YZ Modifies a member variable of class MR::VoxelsSave::SavingSettings named slicePlane.

Calls MR_VoxelsSave_SavingSettings_Set_slicePlane(). The reference to the parameter value might be preserved in this object in element slicePlane.

◆ slice_plane()

auto meshlib::voxels_save::SavingSettings::slice_plane ( ) const -> &meshlib::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.

Calls MR_VoxelsSave_SavingSettings_Get_slicePlane(). The reference to this object might be preserved as the return value.

◆ slice_plane_mut()

auto meshlib::voxels_save::SavingSettings::slice_plane_mut ( ) -> &mut meshlib::SlicePlane

Plane which the object is sliced by. XY, XZ, or YZ Returns a mutable pointer to a member variable of class MR::VoxelsSave::SavingSettings named slicePlane.

Calls MR_VoxelsSave_SavingSettings_GetMutable_slicePlane(). The reference to this object might be preserved as the return value.


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