|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ ImportOptionsKit() [1/2]
HPS.HCA.ImportOptionsKit.ImportOptionsKit |
( |
| ) |
|
|
inline |
◆ ImportOptionsKit() [2/2]
◆ Empty()
override bool HPS.HCA.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.HCA.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()
◆ SetTarget()
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.
- Returns
- A reference to this ImportOptionsKit.
◆ SetView()
Sets a View to be used as part of the import. Setting a View is required for the import to succeed.
- Parameters
-
in_view | View to use for camera tracking. |
- Returns
- A reference to this ImportOptionsKit.
◆ Show()
◆ ShowJavascriptPath()
bool HPS.HCA.ImportOptionsKit.ShowJavascriptPath |
( |
out string |
out_javascript_path | ) |
|
|
inline |
Shows the path that will be used to find hc_access.js during import.
- Parameters
-
out_javascript_path | The path used to reach hc_access.js. |
- Returns
- Returns false if a javascript path setting was not specified, false otherwise.
◆ ShowTarget()
bool HPS.HCA.ImportOptionsKit.ShowTarget |
( |
out HPS.Model |
out_model | ) |
|
|
inline |
Shows the target import setting.
- Parameters
-
out_model | Model to use to implicitly set Segment, Library and Portfolio into which the data will be imported. |
- Returns
- Returns false if a target setting was not specified, false otherwise.
◆ ShowView()
bool HPS.HCA.ImportOptionsKit.ShowView |
( |
out HPS.View |
out_view | ) |
|
|
inline |
Shows the view import setting.
- Parameters
-
- Returns
- Returns false if a view setting was not specified, false otherwise.
◆ UnsetEverything()
◆ UnsetJavascriptPath()
Removes javascript path import setting.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetTarget()
◆ UnsetView()
The documentation for this class was generated from the following file:
- internals/hps_sprk_hca/source/cs/HPS.HCA.cs