HPS::OOC::ImportOptionsKit

class HPS.OOC.ImportOptionsKit : public HPS.Sprocket 

The ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via OOC.

Public Functions

override void Dispose ()

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

override bool Equals (Object obj)

override int GetHashCode ()

ImportOptionsKit (): The default constructor creates an empty ImportOptionsKit object.

ImportOptionsKit (HPS.OOC.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.OOC.ImportOptionsKit in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Param in_kit: The source ImportOptionsKit to copy.

HPS.OOC.ImportOptionsKit SetAreaHighlightTracker (HPS.OOC.AreaHighlightTracker in_area_highlight_tracker)

Sets the AreaHighlightTracker.

Note

You should pass in an instance of a class that derives from AreaHighlightTracker that implements your desired behavior.

Param in_area_highlight_tracker: The AreaHighlightTracker to use for this
Return: A reference to this ImportOptionsKit.

HPS.OOC.ImportOptionsKit SetCenterBounding (bool in_center_bounding)

Configures the model set a transform to the center of the bounding.

Param in_center_bounding: The new center bounding setting
Return: A reference to this ImportOptionsKit.

HPS.OOC.ImportOptionsKit SetManualUpdates (bool in_manual_updates)

Configures the model to only load based on manual updates.

Param in_manual_updates: The new manual update setting
Return: A reference to this ImportOptionsKit.

HPS.OOC.ImportOptionsKit SetTarget (HPS.Model in_target)

Uses the Model to set the root segment, library segment, and portfolio where the data will be imported.

Return: A reference to this ImportOptionsKit.

HPS.OOC.ImportOptionsKit SetTranslation (double in_x, double in_y, double in_z)

Configures a translate to be set on the model.

Param in_x: The x translate
Param in_y: The y translate
Param in_z: The z translate
Return: A reference to this ImportOptionsKit.

void Show (out HPS.OOC.ImportOptionsKit out_kit)

Copies this ImportOptionsKit into the given ImportOptionsKit.

Param out_kit: The ImportOptionsKit to populate with the contents of this ImportOptionsKit.

bool ShowCenterBounding (out bool out_center_bounding)

Shows if the model is configured to transform to the center of the bounding.

Param out_center_bounding: The current center bounding setting
Return: Returns false if there is no manual update setting.

bool ShowManualUpdates (out bool out_manual_updates)

Shows if the model is configured to only load based on manual updates.

Param out_manual_updates: The current manual update setting
Return: Returns false if there is no manual update setting.

bool ShowTarget (out HPS.Model out_model)

Shows the root and library segments and portfolio where the data will be imported. If no segments are specified, root segments will be created for this purpose during import.

Param out_model: Model to use to implicitly set Segment, Library and Portfolio into which the data will be imported.
Return: Returns false if there is no target, false otherwise.

bool ShowTranslation (out double out_x, out double out_y, out double out_z)

Shows if a translate is set.

Param out_x: The x translate
Param out_y: The y translate
Param out_z: The z translate
Return: Returns false if there is no manual update setting.

HPS.OOC.ImportOptionsKit UnsetAreaHighlightTracker ()

Removes the AreaHighlightTracker.

Return: A reference to this ImportOptionsKit.

HPS.OOC.ImportOptionsKit UnsetCenterBounding ()

Removes the center bounding setting.

Return: A reference to this ImportOptionsKit.

HPS.OOC.ImportOptionsKit UnsetEverything ()

Removes all settings from this ImportOptionsKit.

Return: A reference to this ImportOptionsKit.

HPS.OOC.ImportOptionsKit UnsetManualUpdates ()

Removes the manual update setting.

Return: A reference to this ImportOptionsKit.

HPS.OOC.ImportOptionsKit UnsetTarget ()

Removes the target and library segments, and Model import state.

Return: A reference to this ImportOptionsKit.

HPS.OOC.ImportOptionsKit UnsetTranslation ()

Removes a translate setting.

Return: A reference to this ImportOptionsKit.

Public Static Functions

HPS.OOC.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.

bool operator!= (HPS.OOC.ImportOptionsKit a, HPS.OOC.ImportOptionsKit b)

bool operator== (HPS.OOC.ImportOptionsKit a, HPS.OOC.ImportOptionsKit b)