
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.HCA.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.HCA.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.HCA.ImportOptionsKit in_kit) |
Copies the source ImportOptionsKit into this ImportOptionsKit. More... | |
HPS.HCA.ImportOptionsKit | SetEjectedBoundingPreviews (bool ejected_bounding_previews) |
If true the server will provide bounding previews where meshes are ejected because of the memory limits. More... | |
HPS.HCA.ImportOptionsKit | SetJavascriptPath (string javascript_path) |
HPS.HCA.ImportOptionsKit | SetLimitMiB (UInt32 limit_MiB) |
If non-zero this sets the mesh data memory limit in MiB. More... | |
HPS.HCA.ImportOptionsKit | SetModelBoundingPreviews (bool model_bounding_previews) |
If true the server will provide model bounding previews at the start of streaming. More... | |
HPS.HCA.ImportOptionsKit | SetNetworkModelName (string network_model_name) |
HPS.HCA.ImportOptionsKit | SetNetworkPath (string network_path) |
HPS.HCA.ImportOptionsKit | SetTarget (HPS.Model in_target) |
Uses this Model to set the root segment, library segment, and portfolio where the data will be imported. More... | |
HPS.HCA.ImportOptionsKit | SetView (HPS.View in_view) |
Uses the View to interact with the camera. More... | |
void | Show (out HPS.HCA.ImportOptionsKit out_kit) |
Copies this ImportOptionsKit into the given ImportOptionsKit. More... | |
bool | ShowEjectedBoundingPreviews (out bool out_ejected_bounding_previews) |
Shows if the server will provide ejected bounding previews. More... | |
bool | ShowJavascriptPath (out string out_javascript_path) |
Shows the path to the hc_access.js that will be used. More... | |
bool | ShowLimitMiB (out UInt32 out_limit_MiB) |
Shows the mesh data memory limit in MiB. More... | |
bool | ShowModelBoundingPreviews (out bool out_model_bounding_previews) |
Shows if the server will provide model bounding previews at the start of streaming. More... | |
bool | ShowNetworkModelName (out string out_network_model_name) |
Shows the model name that will be used to connect to the Communicator server. More... | |
bool | ShowNetworkPath (out string out_network_path) |
Shows the URL that will be used to connect to the Communicator server. More... | |
bool | ShowTarget (out HPS.Model out_model) |
Shows the model where the data will be imported. More... | |
bool | ShowView (out HPS.View out_view) |
Shows the view that will be used. More... | |
HPS.HCA.ImportOptionsKit | UnsetEjectedBoundingPreviews () |
Removes ejected bounding previews setting. More... | |
HPS.HCA.ImportOptionsKit | UnsetEverything () |
Removes all settings from this ImportOptionsKit. More... | |
HPS.HCA.ImportOptionsKit | UnsetJavascriptPath () |
Removes javascript path. More... | |
HPS.HCA.ImportOptionsKit | UnsetLimitMiB () |
Removes the mesh data memory limit. More... | |
HPS.HCA.ImportOptionsKit | UnsetModelBoundingPreviews () |
Removes model bounding previews setting. More... | |
HPS.HCA.ImportOptionsKit | UnsetNetworkModelName () |
Removes network model name. More... | |
HPS.HCA.ImportOptionsKit | UnsetNetworkPath () |
Removes network path. More... | |
HPS.HCA.ImportOptionsKit | UnsetTarget () |
Removes the target model. More... | |
HPS.HCA.ImportOptionsKit | UnsetView () |
Removes the view. 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.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. More... | |
static bool | operator!= (HPS.HCA.ImportOptionsKit a, HPS.HCA.ImportOptionsKit b) |
static bool | operator== (HPS.HCA.ImportOptionsKit a, HPS.HCA.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 HCA.
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.
◆ SetEjectedBoundingPreviews()
|
inline |
If true the server will provide bounding previews where meshes are ejected because of the memory limits.
- Parameters
-
ejected_bounding_previews Whether ejected mesh boundings will be streamed.
- Returns
- A reference to this ImportOptionsKit.
◆ SetLimitMiB()
|
inline |
If non-zero this sets the mesh data memory limit in MiB.
- Parameters
-
limit_MiB Memory in Mib to use.
- Returns
- A reference to this ImportOptionsKit.
◆ SetModelBoundingPreviews()
|
inline |
If true the server will provide model bounding previews at the start of streaming.
- Parameters
-
model_bounding_previews Whether model boundings will be streamed.
- Returns
- A reference to this ImportOptionsKit.
◆ SetTarget()
|
inline |
Uses this Model to set the root segment, library segment, and portfolio where the data will be imported.
- Returns
- A reference to this ImportOptionsKit.
◆ SetView()
|
inline |
Uses the View to interact with the camera.
- Parameters
-
in_view View to use for camera tracking.
- 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.
◆ ShowEjectedBoundingPreviews()
|
inline |
Shows if the server will provide ejected bounding previews.
- Parameters
-
out_ejected_bounding_previews True if boundings shall be streamed.
- Returns
- Returns false if not set, false otherwise.
◆ ShowJavascriptPath()
|
inline |
Shows the path to the hc_access.js that will be used.
- Parameters
-
out_javascript_path The path.
- Returns
- Returns false if there is no path, false otherwise.
◆ ShowLimitMiB()
|
inline |
Shows the mesh data memory limit in MiB.
- Parameters
-
out_limit_MiB Memory in Mib to use.
- Returns
- Returns false if not set, false otherwise.
◆ ShowModelBoundingPreviews()
|
inline |
Shows if the server will provide model bounding previews at the start of streaming.
- Parameters
-
out_model_bounding_previews True if boundings shall be streamed.
- Returns
- Returns false if not set, false otherwise.
◆ ShowNetworkModelName()
|
inline |
Shows the model name that will be used to connect to the Communicator server.
- Parameters
-
out_network_model_name The name.
- Returns
- Returns false if there is no model name, false otherwise.
◆ ShowNetworkPath()
|
inline |
Shows the URL that will be used to connect to the Communicator server.
- Parameters
-
out_network_path The path.
- Returns
- Returns false if there is no path, false otherwise.
◆ ShowTarget()
|
inline |
Shows the model where the data will be imported.
- 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 model, false otherwise.
◆ ShowView()
|
inline |
Shows the view that will be used.
- Parameters
-
out_view View to use.
- Returns
- Returns false if there is no view, false otherwise.
◆ UnsetEjectedBoundingPreviews()
|
inline |
Removes ejected bounding previews setting.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetEverything()
|
inline |
Removes all settings from this ImportOptionsKit.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetJavascriptPath()
|
inline |
Removes javascript path.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetLimitMiB()
|
inline |
Removes the mesh data memory limit.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetModelBoundingPreviews()
|
inline |
Removes model bounding previews setting.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetNetworkModelName()
|
inline |
Removes network model name.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetNetworkPath()
|
inline |
Removes network path.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetTarget()
|
inline |
Removes the target model.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetView()
|
inline |
Removes the view.
- Returns
- A reference to this ImportOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_hca/source/cs/HPS.HCA.cs