|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The HPS.HCA.NetworkImportOptionsKit class is a user space object. It contains settings controlling what and how Stream Cache data is imported over a network via the HCA Sprocket.
◆ NetworkImportOptionsKit() [1/2]
HPS.HCA.NetworkImportOptionsKit.NetworkImportOptionsKit |
( |
| ) |
|
|
inline |
◆ NetworkImportOptionsKit() [2/2]
◆ Empty()
override bool HPS.HCA.NetworkImportOptionsKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
◆ GetDefault()
Creates an NetworkImportOptionsKit 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 NetworkImportOptionsKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.HCA.NetworkImportOptionsKit.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()
◆ SetEjectedGeometryBoundingPreviews()
Whether to display a bounding mesh to replace geometry that was ejected because of the memory limit being hit. Additionally this option will only be honored if a memory limit is set.
- Parameters
-
ejected_geometry_bounding_previews | Whether ejected geometry should be replaced with boundings. |
- Returns
- A reference to this NetworkImportOptionsKit.
◆ SetLimitMiB()
Sets the memory amount to devote to geometry data, specified in Megabytes. Passing a value of zero to this function is equivalent to calling UnsetLimitMib() Reaching the memory limit will cause some geometry to be ejected from the scene so that more can stream in.
- Parameters
-
limit_MiB | Memory in Megabytes to use for geometry data. |
- Returns
- A reference to this NetworkImportOptionsKit.
◆ SetModelBoundingPreviews()
Whether to load and display previews of the model bounding when streaming starts. As actual geometry starts streaming in, it will replace its bounding.
- Parameters
-
model_bounding_previews | Whether model boundings will be streamed. |
- Returns
- A reference to this NetworkImportOptionsKit.
◆ 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 NetworkImportOptionsKit.
◆ 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 NetworkImportOptionsKit.
◆ Show()
◆ ShowEjectedGeometryBoundingPreviews()
bool HPS.HCA.NetworkImportOptionsKit.ShowEjectedGeometryBoundingPreviews |
( |
out bool |
out_ejected_geometry_bounding_previews | ) |
|
|
inline |
Shows the ejected bounding previews import setting.
- Parameters
-
out_ejected_geometry_bounding_previews | Whether ejected geometry should be replaced with a visualization of its boundings. |
- Returns
- Returns false if an ejected bounding preview setting was not specified false otherwise.
◆ ShowJavascriptPath()
bool HPS.HCA.NetworkImportOptionsKit.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.
◆ ShowLimitMiB()
bool HPS.HCA.NetworkImportOptionsKit.ShowLimitMiB |
( |
out UInt32 |
out_limit_MiB | ) |
|
|
inline |
Shows the memory limit import setting.
- Parameters
-
out_limit_MiB | The amount of memory, specified in Megabytes, to use for geometry data. |
- Returns
- Returns false if a memory limit setting was not specified, false otherwise.
◆ ShowModelBoundingPreviews()
bool HPS.HCA.NetworkImportOptionsKit.ShowModelBoundingPreviews |
( |
out bool |
out_model_bounding_previews | ) |
|
|
inline |
Shows the model bounding preview import setting.
- Parameters
-
out_model_bounding_previews | Whether boundings should be visualized while waiting for geometry to stream in. |
- Returns
- Returns false if a model bounding preview setting was not specified, false otherwise.
◆ ShowNetworkPath()
bool HPS.HCA.NetworkImportOptionsKit.ShowNetworkPath |
( |
out string |
out_network_path | ) |
|
|
inline |
Shows the network path import setting.
- Parameters
-
out_network_path | The network path to use during the import. |
- Returns
- Returns false if a network path setting was not specified, false otherwise.
◆ ShowTarget()
bool HPS.HCA.NetworkImportOptionsKit.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.NetworkImportOptionsKit.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.
◆ UnsetEjectedGeometryBoundingPreviews()
◆ UnsetEverything()
◆ UnsetJavascriptPath()
◆ UnsetLimitMiB()
◆ UnsetModelBoundingPreviews()
◆ UnsetNetworkPath()
◆ UnsetTarget()
◆ UnsetView()
The documentation for this class was generated from the following file:
- internals/hps_sprk_hca/source/cs/HPS.HCA.cs