
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ImportOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.OOC.ImportOptionsKit in_kit) |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More... | |
override int | GetHashCode () |
ImportOptionsKit () | |
The default constructor creates an empty ImportOptionsKit object. More... | |
ImportOptionsKit (HPS.OOC.ImportOptionsKit in_kit) | |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit. More... | |
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). More... | |
void | Set (HPS.OOC.ImportOptionsKit in_kit) |
Copies the source ImportOptionsKit into this ImportOptionsKit. More... | |
HPS.OOC.ImportOptionsKit | SetAreaHighlightTracker (HPS.OOC.AreaHighlightTracker in_area_highlight_tracker) |
Sets the AreaHighlightTracker. More... | |
HPS.OOC.ImportOptionsKit | SetCenterBounding (bool in_center_bounding) |
Configures the model set a transform to the center of the bounding. More... | |
HPS.OOC.ImportOptionsKit | SetManualUpdates (bool in_manual_updates) |
Configures the model to only load based on manual updates. More... | |
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. More... | |
HPS.OOC.ImportOptionsKit | SetTranslation (double in_x, double in_y, double in_z) |
Configures a translate to be set on the model. More... | |
void | Show (out HPS.OOC.ImportOptionsKit out_kit) |
Copies this ImportOptionsKit into the given ImportOptionsKit. More... | |
bool | ShowCenterBounding (out bool out_center_bounding) |
Shows if the model is configured to transform to the center of the bounding. More... | |
bool | ShowManualUpdates (out bool out_manual_updates) |
Shows if the model is configured to only load based on manual updates. More... | |
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. More... | |
bool | ShowTranslation (out double out_x, out double out_y, out double out_z) |
Shows if a translate is set. More... | |
HPS.OOC.ImportOptionsKit | UnsetAreaHighlightTracker () |
Removes the AreaHighlightTracker. More... | |
HPS.OOC.ImportOptionsKit | UnsetCenterBounding () |
Removes the center bounding setting. More... | |
HPS.OOC.ImportOptionsKit | UnsetEverything () |
Removes all settings from this ImportOptionsKit. More... | |
HPS.OOC.ImportOptionsKit | UnsetManualUpdates () |
Removes the manual update setting. More... | |
HPS.OOC.ImportOptionsKit | UnsetTarget () |
Removes the target and library segments, and Model import state. More... | |
HPS.OOC.ImportOptionsKit | UnsetTranslation () |
Removes a translate setting. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Public Member Functions | |
static 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. More... | |
static bool | operator!= (HPS.OOC.ImportOptionsKit a, HPS.OOC.ImportOptionsKit b) |
static bool | operator== (HPS.OOC.ImportOptionsKit a, HPS.OOC.ImportOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via OOC.
Constructor & Destructor Documentation
◆ ImportOptionsKit() [1/2]
|
inline |
The default constructor creates an empty ImportOptionsKit object.
◆ ImportOptionsKit() [2/2]
|
inline |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
Member Function Documentation
◆ 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()
|
inline |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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. 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()
|
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()
|
inline |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
◆ SetAreaHighlightTracker()
|
inline |
Sets the AreaHighlightTracker.
- Parameters
-
in_area_highlight_tracker The AreaHighlightTracker to use for this
- Returns
- A reference to this ImportOptionsKit.
◆ SetCenterBounding()
|
inline |
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()
|
inline |
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()
|
inline |
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()
|
inline |
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()
|
inline |
Copies this ImportOptionsKit into the given ImportOptionsKit.
- Parameters
-
out_kit The ImportOptionsKit to populate with the contents of this ImportOptionsKit.
◆ ShowCenterBounding()
|
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()
|
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()
|
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()
|
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()
|
inline |
Removes the AreaHighlightTracker.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetCenterBounding()
|
inline |
Removes the center bounding setting.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetEverything()
|
inline |
Removes all settings from this ImportOptionsKit.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetManualUpdates()
|
inline |
Removes the manual update setting.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetTarget()
|
inline |
Removes the target and library segments, and Model import state.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetTranslation()
|
inline |
Removes a translate setting.
- Returns
- A reference to this ImportOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_ooc/source/cs/HPS.OOC.cs