Inheritance diagram for HPS.STL.ImportOptionsKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.STL.ImportOptionsKit in_kit)
 
override int GetHashCode ()
 
 ImportOptionsKit ()
 
 ImportOptionsKit (HPS.STL.ImportOptionsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.STL.ImportOptionsKit in_kit)
 
HPS.STL.ImportOptionsKit SetOptimization (bool in_state, HPS.ShellOptimizationOptionsKit in_optimization_kit)
 
HPS.STL.ImportOptionsKit SetOptimization (HPS.ShellOptimizationOptionsKit in_optimization_kit)
 
HPS.STL.ImportOptionsKit SetSegment (HPS.SegmentKey in_segment)
 
void Show (out HPS.STL.ImportOptionsKit out_kit)
 
bool ShowOptimization (out bool out_state, out HPS.ShellOptimizationOptionsKit out_optimization_options)
 
bool ShowSegment (out HPS.SegmentKey out_segment)
 
HPS.STL.ImportOptionsKit UnsetEverything ()
 
HPS.STL.ImportOptionsKit UnsetOptimization ()
 
HPS.STL.ImportOptionsKit UnsetSegment ()
 
- Public Member Functions inherited from HPS.Kit
Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.STL.ImportOptionsKit GetDefault ()
 
static bool operator!= (HPS.STL.ImportOptionsKit a, HPS.STL.ImportOptionsKit b)
 
static bool operator== (HPS.STL.ImportOptionsKit a, HPS.STL.ImportOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/2]

HPS.STL.ImportOptionsKit.ImportOptionsKit ( )
inline

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/2]

HPS.STL.ImportOptionsKit.ImportOptionsKit ( HPS.STL.ImportOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ImportOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.STL.ImportOptionsKit.Empty ( )
inlinevirtual

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 ( HPS.STL.ImportOptionsKit  in_kit)
inline

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.

◆ GetDefault()

static HPS.STL.ImportOptionsKit HPS.STL.ImportOptionsKit.GetDefault ( )
inlinestatic

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.

◆ ObjectType()

override HPS.Type HPS.STL.ImportOptionsKit.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Kit.

◆ Set()

void HPS.STL.ImportOptionsKit.Set ( HPS.STL.ImportOptionsKit  in_kit)
inline

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ SetOptimization() [1/2]

HPS.STL.ImportOptionsKit HPS.STL.ImportOptionsKit.SetOptimization ( bool  in_state,
HPS.ShellOptimizationOptionsKit  in_optimization_kit 
)
inline

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]

HPS.STL.ImportOptionsKit HPS.STL.ImportOptionsKit.SetOptimization ( HPS.ShellOptimizationOptionsKit  in_optimization_kit)
inline

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()

HPS.STL.ImportOptionsKit HPS.STL.ImportOptionsKit.SetSegment ( HPS.SegmentKey  in_segment)
inline

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 ( out HPS.STL.ImportOptionsKit  out_kit)
inline

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 ( out bool  out_state,
out HPS.ShellOptimizationOptionsKit  out_optimization_options 
)
inline

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 ( out HPS.SegmentKey  out_segment)
inline

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.

◆ UnsetEverything()

HPS.STL.ImportOptionsKit HPS.STL.ImportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.

◆ UnsetOptimization()

HPS.STL.ImportOptionsKit HPS.STL.ImportOptionsKit.UnsetOptimization ( )
inline

Removes the optimization options for this import

Returns
A reference to this ImportOptionsKit.

◆ UnsetSegment()

HPS.STL.ImportOptionsKit HPS.STL.ImportOptionsKit.UnsetSegment ( )
inline

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

Returns
A reference to this ImportOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.STL.cs