HPS.HCA.ImportOptionsKit

class HPS.HCA.ImportOptionsKit : public HPS.Sprocket

The HPS.HCA.ImportOptionsKit class is a user space object. It contains settings controlling what and how Stream Cache data is imported via the HCA Sprocket.

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.HCA.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.HCA.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.HCA.ImportOptionsKit in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Param in_kit

The source ImportOptionsKit to copy.

HPS.HCA.ImportOptionsKit SetTarget (HPS.Model in_target)

Sets a Model to be used as part of the import. Geometry will be imported in the model Segment, and definitions will be added to the Portfolio associated with the Model provided. Setting a target is required for the import to succeed.

Return

A reference to this ImportOptionsKit.

HPS.HCA.ImportOptionsKit SetView (HPS.View in_view)

Sets a View to be used as part of the import. Setting a View is required for the import to succeed.

Param in_view

View to use for camera tracking.

Return

A reference to this ImportOptionsKit.

void Show (out HPS.HCA.ImportOptionsKit out_kit)

Copies this ImportOptionsKit into the given ImportOptionsKit.

Param out_kit

The ImportOptionsKit to populate with the contents of this ImportOptionsKit.

bool ShowJavascriptPath (out string out_javascript_path)

Shows the path that will be used to find hc_access.js during import.

Param out_javascript_path

The path used to reach hc_access.js.

Return

Returns false if a javascript path setting was not specified, false otherwise.

bool ShowTarget (out HPS.Model out_model)

Shows the target import setting.

Param out_model

Model to use to implicitly set Segment, Library and Portfolio into which the data will be imported.

Return

Returns false if a target setting was not specified, false otherwise.

bool ShowView (out HPS.View out_view)

Shows the view import setting.

Param out_view

View to use.

Return

Returns false if a view setting was not specified, false otherwise.

HPS.HCA.ImportOptionsKit UnsetEverything ()

Removes all settings from this ImportOptionsKit.

Return

A reference to this ImportOptionsKit.

HPS.HCA.ImportOptionsKit UnsetJavascriptPath ()

Removes javascript path import setting.

Return

A reference to this ImportOptionsKit.

HPS.HCA.ImportOptionsKit UnsetTarget ()

Removes the target import setting.

Return

A reference to this ImportOptionsKit.

HPS.HCA.ImportOptionsKit UnsetView ()

Removes the view import setting.

Return

A reference to this ImportOptionsKit.

Public Static Functions

HPS.HCA.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. These values will be used for import unless an option is overridden by the options passed to File.Import.

Return

An ImportOptionsKit with the default settings.