HPS.HCA.NetworkImportOptionsKit

class HPS.HCA.NetworkImportOptionsKit : public HPS.Sprocket 

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.

Public Functions

override bool Empty ()

Indicates whether this NetworkImportOptionsKit has any values set on it.

Return: true if no values are set on this NetworkImportOptionsKit, false otherwise.

bool Equals (HPS.HCA.NetworkImportOptionsKit in_kit)

Check if the source NetworkImportOptionsKit is equivalent to this NetworkImportOptionsKit.

Param in_kit: The source NetworkImportOptionsKit to compare to this NetworkImportOptionsKit.
Return: true if the objects are equivalent, false otherwise.

NetworkImportOptionsKit (): The default constructor creates an empty NetworkImportOptionsKit object.

NetworkImportOptionsKit (HPS.HCA.NetworkImportOptionsKit in_kit)

The copy constructor creates a new NetworkImportOptionsKit object that contains the same settings as the source NetworkImportOptionsKit.

Param in_kit: The source NetworkImportOptionsKit to copy.

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).

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.HCA.NetworkImportOptionsKit in_kit)

Copies the source NetworkImportOptionsKit into this NetworkImportOptionsKit.

Param in_kit: The source NetworkImportOptionsKit to copy.

HPS.HCA.NetworkImportOptionsKit SetEjectedGeometryBoundingPreviews (bool ejected_geometry_bounding_previews)

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.

Param ejected_geometry_bounding_previews: Whether ejected geometry should be replaced with boundings.
Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit SetLimitMiB (UInt32 limit_MiB)

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.

Param limit_MiB: Memory in Megabytes to use for geometry data.
Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit SetModelBoundingPreviews (bool model_bounding_previews)

Whether to load and display previews of the model bounding when streaming starts. As actual geometry starts streaming in, it will replace its bounding.

Param model_bounding_previews: Whether model boundings will be streamed.
Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit SetTarget (HPS.Model in_target)

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.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit SetView (HPS.View in_view)

Sets a View to be used as part of the import. Setting a View is required for the import to succeed.

Param in_view: View to use for camera tracking.
Return: A reference to this NetworkImportOptionsKit.

void Show (out HPS.HCA.NetworkImportOptionsKit out_kit)

Copies this NetworkImportOptionsKit into the given NetworkImportOptionsKit.

Param out_kit: The NetworkImportOptionsKit to populate with the contents of this NetworkImportOptionsKit.

bool ShowEjectedGeometryBoundingPreviews (out bool out_ejected_geometry_bounding_previews)

Shows the ejected bounding previews import setting.

Param out_ejected_geometry_bounding_previews: Whether ejected geometry should be replaced with a visualization of its boundings.
Return: Returns false if an ejected bounding preview setting was not specified false otherwise.

bool ShowJavascriptPath (out string out_javascript_path)

Shows the path that will be used to find hc_access.js during import.

Param out_javascript_path: The path used to reach hc_access.js.
Return: Returns false if a javascript path setting was not specified, false otherwise.

bool ShowLimitMiB (out UInt32 out_limit_MiB)

Shows the memory limit import setting.

Param out_limit_MiB: The amount of memory, specified in Megabytes, to use for geometry data.
Return: Returns false if a memory limit setting was not specified, false otherwise.

bool ShowModelBoundingPreviews (out bool out_model_bounding_previews)

Shows the model bounding preview import setting.

Param out_model_bounding_previews: Whether boundings should be visualized while waiting for geometry to stream in.
Return: Returns false if a model bounding preview setting was not specified, false otherwise.

bool ShowNetworkPath (out string out_network_path)

Shows the network path import setting.

Param out_network_path: The network path to use during the import.
Return: Returns false if a network path setting was not specified, false otherwise.

bool ShowTarget (out HPS.Model out_model)

Shows the target import setting.

Param out_model: Model to use to implicitly set Segment, Library and Portfolio into which the data will be imported.
Return: Returns false if a target setting was not specified, false otherwise.

bool ShowView (out HPS.View out_view)

Shows the view import setting.

Param out_view: View to use.
Return: Returns false if a view setting was not specified, false otherwise.

HPS.HCA.NetworkImportOptionsKit UnsetEjectedGeometryBoundingPreviews ()

Removes ejected bounding previews setting import setting.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit UnsetEverything ()

Removes all settings from this NetworkImportOptionsKit.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit UnsetJavascriptPath ()

Removes javascript path import setting.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit UnsetLimitMiB ()

Removes the geometry data memory limit import setting.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit UnsetModelBoundingPreviews ()

Removes model bounding previews setting import setting.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit UnsetNetworkPath ()

Removes network path import setting.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit UnsetTarget ()

Removes the target import setting.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit UnsetView ()

Removes the view import setting.

Return: A reference to this NetworkImportOptionsKit.

Public Static Functions

HPS.HCA.NetworkImportOptionsKit 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.

Return: An NetworkImportOptionsKit with the default settings.