|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via OOC.
◆ ImportOptionsKit() [1/2]
HPS.OOC.ImportOptionsKit.ImportOptionsKit |
( |
| ) |
|
|
inline |
◆ ImportOptionsKit() [2/2]
◆ Empty()
override bool HPS.OOC.ImportOptionsKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
◆ 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.
- Returns
- An ImportOptionsKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.OOC.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.Object.
◆ Set()
◆ SetAreaHighlightTracker()
◆ SetCenterBounding()
Configures the model set a transform to the center of the bounding.
- Parameters
-
in_center_bounding | The new center bounding setting |
- Returns
- A reference to this ImportOptionsKit.
◆ SetManualUpdates()
Configures the model to only load based on manual updates.
- Parameters
-
in_manual_updates | The new manual update setting |
- Returns
- A reference to this ImportOptionsKit.
◆ SetTarget()
Uses the Model to set the root segment, library segment, and portfolio where the data will be imported.
- Returns
- A reference to this ImportOptionsKit.
◆ SetTranslation()
Configures a translate to be set on the model.
- Parameters
-
in_x | The x translate |
in_y | The y translate |
in_z | The z translate |
- Returns
- A reference to this ImportOptionsKit.
◆ Show()
◆ ShowCenterBounding()
bool HPS.OOC.ImportOptionsKit.ShowCenterBounding |
( |
out bool |
out_center_bounding | ) |
|
|
inline |
Shows if the model is configured to transform to the center of the bounding.
- Parameters
-
out_center_bounding | The current center bounding setting |
- Returns
- Returns false if there is no manual update setting.
◆ ShowManualUpdates()
bool HPS.OOC.ImportOptionsKit.ShowManualUpdates |
( |
out bool |
out_manual_updates | ) |
|
|
inline |
Shows if the model is configured to only load based on manual updates.
- Parameters
-
out_manual_updates | The current manual update setting |
- Returns
- Returns false if there is no manual update setting.
◆ ShowTarget()
bool HPS.OOC.ImportOptionsKit.ShowTarget |
( |
out HPS.Model |
out_model | ) |
|
|
inline |
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.
- Parameters
-
out_model | Model to use to implicitly set Segment, Library and Portfolio into which the data will be imported. |
- Returns
- Returns false if there is no target, false otherwise.
◆ ShowTranslation()
bool HPS.OOC.ImportOptionsKit.ShowTranslation |
( |
out double |
out_x, |
|
|
out double |
out_y, |
|
|
out double |
out_z |
|
) |
| |
|
inline |
Shows if a translate is set.
- Parameters
-
out_x | The x translate |
out_y | The y translate |
out_z | The z translate |
- Returns
- Returns false if there is no manual update setting.
◆ UnsetAreaHighlightTracker()
◆ UnsetCenterBounding()
Removes the center bounding setting.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetEverything()
◆ UnsetManualUpdates()
◆ UnsetTarget()
Removes the target and library segments, and Model import state.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetTranslation()
The documentation for this class was generated from the following file:
- internals/hps_sprk_ooc/source/cs/HPS.OOC.cs