Hoops Visualize HPS  version 2018-SP2
Hoops Visualize HPS 3D Rendering Engine
Looking for a senior C++ dev?
I'm looking for work. Hire me!
HPS::STL::ImportOptionsKit Class Reference

The ImportOptionsKit class contains any settings controlling the import of STL files. More...

#include <hps.h>

Inheritance diagram for HPS::STL::ImportOptionsKit:
Collaboration diagram for HPS::STL::ImportOptionsKit:

Public Member Functions

 ImportOptionsKit ()
 The default constructor creates an empty ImportOptionsKit object. More...
 
 ImportOptionsKit (ImportOptionsKit const &in_kit)
 The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit. More...
 
 ImportOptionsKit (ImportOptionsKit &&in_that)
 The move constructor creates an ImportOptionsKit by transferring the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy and allocation. More...
 
ImportOptionsKitoperator= (ImportOptionsKit &&in_that)
 The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy. More...
 
virtual ~ImportOptionsKit ()
 
HPS::Type ObjectType () const
 
void Set (ImportOptionsKit const &in_kit)
 Copies the source ImportOptionsKit into this ImportOptionsKit. More...
 
void Show (ImportOptionsKit &out_kit) const
 Copies this ImportOptionsKit into the given ImportOptionsKit. More...
 
ImportOptionsKitoperator= (ImportOptionsKit const &in_kit)
 Copies the source ImportOptionsKit into this ImportOptionsKit. More...
 
bool Empty () const
 Indicates whether this ImportOptionsKit has any values set on it. More...
 
bool Equals (ImportOptionsKit const &in_kit) const
 Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More...
 
bool operator== (ImportOptionsKit const &in_kit) const
 Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More...
 
bool operator!= (ImportOptionsKit const &in_kit) const
 Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit. More...
 
ImportOptionsKitSetSegment (SegmentKey const &in_segment)
 Sets the root segment where the STL data will be imported into. More...
 
ImportOptionsKitSetOptimization (bool in_state, ShellOptimizationOptionsKit const &in_optimization_kit)
 Sets the options for the optimization performed on the shells created as a result of this import. More...
 
ImportOptionsKitSetOptimization (ShellOptimizationOptionsKit const &in_optimization_kit)
 Sets the options for the optimization performed on the shells created as a result of this import. More...
 
ImportOptionsKitUnsetSegment ()
 Removes the root segment specifying where the STL data will be imported into. More...
 
ImportOptionsKitUnsetOptimization ()
 Removes the optimization options for this import. More...
 
ImportOptionsKitUnsetEverything ()
 Removes all settings from this ImportOptionsKit. More...
 
bool ShowSegment (SegmentKey &out_segment) const
 Shows the root segment where the STL data will be imported into. More...
 
bool ShowOptimization (bool &out_state, ShellOptimizationOptionsKit &out_optimization_options) const
 Shows the optimization options for this import. More...
 
virtual HPS::Type Type () const
 This function returns the true type of the underlying object. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS::Type in_mask) const
 This function indicates whether this Object has the given Type mask. More...
 
intptr_t GetClassID () const
 Returns a unique identifier that is shared by all objects of the same class. More...
 
intptr_t GetInstanceID () const
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 

Static Public Member Functions

static ImportOptionsKit GetDefault ()
 Creates an ImportOptionsKit which contains the default settings. More...
 
template<typename T >
static intptr_t ClassID ()
 Unique identifier for this class. More...
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::STLImportOptionsKit
 

Detailed Description

The ImportOptionsKit class contains any settings controlling the import of STL files.

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/3]

HPS::STL::ImportOptionsKit::ImportOptionsKit ( )

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/3]

HPS::STL::ImportOptionsKit::ImportOptionsKit ( ImportOptionsKit const &  in_kit)

The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ ImportOptionsKit() [3/3]

HPS::STL::ImportOptionsKit::ImportOptionsKit ( ImportOptionsKit &&  in_that)

The move constructor creates an ImportOptionsKit by transferring the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to an ImportOptionsKit to take the impl from.

◆ ~ImportOptionsKit()

virtual HPS::STL::ImportOptionsKit::~ImportOptionsKit ( )
virtual

Member Function Documentation

◆ ClassID()

template<typename T >
static intptr_t HPS::Object::ClassID ( )
inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Empty()

bool HPS::STL::ImportOptionsKit::Empty ( ) const
virtual

Indicates whether this ImportOptionsKit has any values set on it.

Returns
true if no values are set on this ImportOptionsKit, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::STL::ImportOptionsKit::Equals ( ImportOptionsKit const &  in_kit) const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const
inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns
A unique value shared by all objects of the same class.

◆ GetDefault()

static ImportOptionsKit HPS::STL::ImportOptionsKit::GetDefault ( )
static

Creates an ImportOptionsKit 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.

Returns
An ImportOptionsKit with the default settings.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const
inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns
A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask) const
inherited

This function indicates whether this Object has the given Type mask.

Parameters
in_maskThe Type mask to check against this Object.
Returns
true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::STL::ImportOptionsKit::ObjectType ( ) const
inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::STL::ImportOptionsKit::operator!= ( ImportOptionsKit const &  in_kit) const

Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

ImportOptionsKit& HPS::STL::ImportOptionsKit::operator= ( ImportOptionsKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to an ImportOptionsKit to take the impl from.
Returns
A reference to this ImportOptionsKit.

◆ operator=() [2/2]

ImportOptionsKit& HPS::STL::ImportOptionsKit::operator= ( ImportOptionsKit const &  in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.
Returns
A reference to this ImportOptionsKit.

◆ operator==()

bool HPS::STL::ImportOptionsKit::operator== ( ImportOptionsKit const &  in_kit) const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Reset()

◆ Set()

void HPS::STL::ImportOptionsKit::Set ( ImportOptionsKit const &  in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ SetOptimization() [1/2]

ImportOptionsKit& HPS::STL::ImportOptionsKit::SetOptimization ( bool  in_state,
ShellOptimizationOptionsKit const &  in_optimization_kit 
)

Sets the options for the optimization performed on the shells created as a result of this import.

Turning off optimization generally results in slightly faster load times and better visual fidelity, but has the downside of impacting performance.

Turning optimization on increases the load time at the expense of visual fidelity but increases performance, based on the options chosen. The tolerances set as part of the optimization kit are particularly responsible for downgrading the visual fidelity. Supplying an empty optimization kit will disable optimization.

Parameters
in_stateWhether the optimization should be enabled.
in_optimization_kitThe optimization options for this import
Returns
A reference to this ImportOptionsKit.

◆ SetOptimization() [2/2]

ImportOptionsKit& HPS::STL::ImportOptionsKit::SetOptimization ( ShellOptimizationOptionsKit const &  in_optimization_kit)

Sets the options for the optimization performed on the shells created as a result of this import.

Turning off optimization generally results in slightly faster load times and better visual fidelity, but has the downside of impacting performance.

Turning optimization on increases the load time at the expense of visual fidelity but increases performance, based on the options chosen. The tolerances set as part of the optimization kit are particularly responsible for downgrading the visual fidelity. Supplying an empty optimization kit will disable optimization.

Parameters
in_optimization_kitThe optimization options for this import
Returns
A reference to this ImportOptionsKit.

◆ SetSegment()

ImportOptionsKit& HPS::STL::ImportOptionsKit::SetSegment ( SegmentKey const &  in_segment)

Sets the root segment where the STL data will be imported into.

If no segment is specified, a root segment will be created for this purpose during import.

Parameters
in_segmentSegment the STL data will be imported into.
Returns
A reference to this ImportOptionsKit.

◆ Show()

void HPS::STL::ImportOptionsKit::Show ( ImportOptionsKit out_kit) const

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters
out_kitThe ImportOptionsKit to populate with the contents of this ImportOptionsKit.

◆ ShowOptimization()

bool HPS::STL::ImportOptionsKit::ShowOptimization ( bool &  out_state,
ShellOptimizationOptionsKit out_optimization_options 
) const

Shows the optimization options for this import.

Parameters
out_stateWhether optimization is enabled.
out_optimization_optionsOptimization options for this import.
Returns
true if optimization options were specified, false otherwise.

◆ ShowSegment()

bool HPS::STL::ImportOptionsKit::ShowSegment ( SegmentKey out_segment) const

Shows the root segment where the STL data will be imported into.

Parameters
out_segmentSegment the STL data will be imported into.
Returns
true if a root segment was specified, false otherwise.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const
inlinevirtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns
The true type of the object in question.

Reimplemented from HPS::Object.

◆ UnsetEverything()

ImportOptionsKit& HPS::STL::ImportOptionsKit::UnsetEverything ( )

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.

◆ UnsetOptimization()

ImportOptionsKit& HPS::STL::ImportOptionsKit::UnsetOptimization ( )

Removes the optimization options for this import.

Returns
A reference to this ImportOptionsKit.

◆ UnsetSegment()

ImportOptionsKit& HPS::STL::ImportOptionsKit::UnsetSegment ( )

Removes the root segment specifying where the STL data will be imported into.

Returns
A reference to this ImportOptionsKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::STL::ImportOptionsKit::staticType = HPS::Type::STLImportOptionsKit
static

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