HPS.STL.ImportOptionsKit

class HPS.STL.ImportOptionsKit : public HPS.Kit

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

Public Functions

override bool Empty ()

Indicates whether this ImportOptionsKit has any values set on it.

Return

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

bool Equals (HPS.STL.ImportOptionsKit in_kit)

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Param in_kit

The source ImportOptionsKit to compare to this ImportOptionsKit.

Return

true if the objects are equivalent, false otherwise.

ImportOptionsKit ()

The default constructor creates an empty ImportOptionsKit object.

ImportOptionsKit (HPS.STL.ImportOptionsKit in_kit)

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

Param in_kit

The source ImportOptionsKit to copy.

override HPS.Type ObjectType ()

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

Return

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

void Set (HPS.STL.ImportOptionsKit in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Param in_kit

The source ImportOptionsKit to copy.

HPS.STL.ImportOptionsKit SetOptimization (bool in_state, HPS.ShellOptimizationOptionsKit 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.

Param in_state

Whether the optimization should be enabled.

Param in_optimization_kit

The optimization options for this import

Return

A reference to this ImportOptionsKit.

HPS.STL.ImportOptionsKit SetOptimization (HPS.ShellOptimizationOptionsKit 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.

Param in_optimization_kit

The optimization options for this import

Return

A reference to this ImportOptionsKit.

HPS.STL.ImportOptionsKit SetSegment (HPS.SegmentKey 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.

Param in_segment

Segment the STL data will be imported into.

Return

A reference to this ImportOptionsKit.

void Show (out HPS.STL.ImportOptionsKit out_kit)

Copies this ImportOptionsKit into the given ImportOptionsKit.

Param out_kit

The ImportOptionsKit to populate with the contents of this ImportOptionsKit.

bool ShowOptimization (out bool out_state, out HPS.ShellOptimizationOptionsKit out_optimization_options)

Shows the optimization options for this import

Param out_state

Whether optimization is enabled.

Param out_optimization_options

Optimization options for this import.

Return

true if optimization options were specified, false otherwise.

bool ShowSegment (out HPS.SegmentKey out_segment)

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

Param out_segment

Segment the STL data will be imported into.

Return

true if a root segment was specified, false otherwise.

HPS.STL.ImportOptionsKit UnsetEverything ()

Removes all settings from this ImportOptionsKit.

Return

A reference to this ImportOptionsKit.

HPS.STL.ImportOptionsKit UnsetOptimization ()

Removes the optimization options for this import

Return

A reference to this ImportOptionsKit.

HPS.STL.ImportOptionsKit UnsetSegment ()

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

Return

A reference to this ImportOptionsKit.

Public Static Functions

HPS.STL.ImportOptionsKit GetDefault ()

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.

Return

An ImportOptionsKit with the default settings.