REFERENCE MANUAL
Static Public Member Functions | |
static CutGeometryGatheringOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
CutGeometryGatheringOptionsKit::CutGeometryGatheringOptionsKit | ( | ) |
The default constructor creates an empty CutGeometryGatheringOptionsKit object.
CutGeometryGatheringOptionsKit::CutGeometryGatheringOptionsKit | ( | CutGeometryGatheringOptionsKit const & | in_kit | ) |
The copy constructor creates a new CutGeometryGatheringOptionsKit object that contains the same settings as the source CutGeometryGatheringOptionsKit.
in_kit | The source CutGeometryGatheringOptionsKit to copy. |
CutGeometryGatheringOptionsKit::CutGeometryGatheringOptionsKit | ( | CutGeometryGatheringOptionsKit && | in_that | ) |
The move constructor creates a CutGeometryGatheringOptionsKit by transferring the underlying impl of the rvalue reference to this CutGeometryGatheringOptionsKit thereby avoiding a copy and allocation.
in_that | An rvalue reference to a CutGeometryGatheringOptionsKit to take the impl from. |
|
virtual |
Indicates whether this CutGeometryGatheringOptionsKit has any values set on it.
Reimplemented from Object.
bool CutGeometryGatheringOptionsKit::Equals | ( | CutGeometryGatheringOptionsKit const & | in_kit | ) | const |
Check if the source CutGeometryGatheringOptionsKit is equivalent to this CutGeometryGatheringOptionsKit.
in_kit | The source CutGeometryGatheringOptionsKit to compare to this CutGeometryGatheringOptionsKit. |
|
static |
Creates a CutGeometryGatheringOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
bool CutGeometryGatheringOptionsKit::operator!= | ( | CutGeometryGatheringOptionsKit const & | in_kit | ) | const |
Check if the source CutGeometryGatheringOptionsKit is not equivalent to this CutGeometryGatheringOptionsKit.
in_kit | The source CutGeometryGatheringOptionsKit to compare to this CutGeometryGatheringOptionsKit. |
CutGeometryGatheringOptionsKit& CutGeometryGatheringOptionsKit::operator= | ( | CutGeometryGatheringOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this CutGeometryGatheringOptionsKit thereby avoiding a copy.
in_that | An rvalue reference to a CutGeometryGatheringOptionsKit to take the impl from. |
CutGeometryGatheringOptionsKit& CutGeometryGatheringOptionsKit::operator= | ( | CutGeometryGatheringOptionsKit const & | in_kit | ) |
Copies the source CutGeometryGatheringOptionsKit into this CutGeometryGatheringOptionsKit.
in_kit | The source CutGeometryGatheringOptionsKit to copy. |
bool CutGeometryGatheringOptionsKit::operator== | ( | CutGeometryGatheringOptionsKit const & | in_kit | ) | const |
Check if the source CutGeometryGatheringOptionsKit is equivalent to this CutGeometryGatheringOptionsKit.
in_kit | The source CutGeometryGatheringOptionsKit to compare to this CutGeometryGatheringOptionsKit. |
void CutGeometryGatheringOptionsKit::Set | ( | CutGeometryGatheringOptionsKit const & | in_kit | ) |
Copies the source CutGeometryGatheringOptionsKit into this CutGeometryGatheringOptionsKit.
in_kit | The source CutGeometryGatheringOptionsKit to copy. |
CutGeometryGatheringOptionsKit& CutGeometryGatheringOptionsKit::SetCuttingSection | ( | CuttingSectionKey const & | in_cutter | ) |
Sets a single cutting section for which to collect capping geometry. If this is not specified, caps for all cutting sections will be collected.
in_cutter | A single cutting section that is interesting for capping geometry collection. |
CutGeometryGatheringOptionsKit& CutGeometryGatheringOptionsKit::SetLevel | ( | CuttingSection::GatheringLevel | in_level | ) |
Sets the level at which to collect the capping geometry.
in_level | Whether the capping geometry should be collected from just a single segment or an entire subtree. |
CutGeometryGatheringOptionsKit& CutGeometryGatheringOptionsKit::SetOffset | ( | size_t | in_offset | ) |
If a single cutting section is specified, this sets the plane offset into that section. If this is not set, all planes in that section will be collected.
in_offset | An offset for a single plane in a cutting section. |
void CutGeometryGatheringOptionsKit::Show | ( | CutGeometryGatheringOptionsKit & | out_kit | ) | const |
Copies this CutGeometryGatheringOptionsKit into the given CutGeometryGatheringOptionsKit.
out_kit | The CutGeometryGatheringOptionsKit to populate with the contents of this CutGeometryGatheringOptionsKit. |
bool CutGeometryGatheringOptionsKit::ShowCuttingSection | ( | CuttingSectionKey & | out_cutter | ) | const |
Shows a cutting section that is interesting for capping geometry collection.
out_cutter | A cutting section that is interesting for capping geometry collection. |
bool CutGeometryGatheringOptionsKit::ShowLevel | ( | CuttingSection::GatheringLevel & | out_level | ) | const |
Shows the level at which to collect the capping geometry.
out_level | Whether the capping geometry should be collected from just a single segment or an entire subtree. |
bool CutGeometryGatheringOptionsKit::ShowOffset | ( | size_t & | out_offset | ) | const |
Shows an offset for a single plane in a cutting section.
out_offset | An offset for a single plane in a cutting section. |
CutGeometryGatheringOptionsKit& CutGeometryGatheringOptionsKit::UnsetCuttingSection | ( | ) |
Removes a single cutting section for which to collect capping geometry.
CutGeometryGatheringOptionsKit& CutGeometryGatheringOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this CutGeometryGatheringOptionsKit.
CutGeometryGatheringOptionsKit& CutGeometryGatheringOptionsKit::UnsetLevel | ( | ) |
Removes the level setting at which to collect the capping geometry.
CutGeometryGatheringOptionsKit& CutGeometryGatheringOptionsKit::UnsetOffset | ( | ) |
Removes an offset for a single plane in a cutting section.