HPS.HCA.NetworkImportOptionsKit Class Reference

Inheritance diagram for HPS.HCA.NetworkImportOptionsKit:

Public Member Functions
override void	Dispose ()
override bool	Empty ()
override bool	Equals (System.Object obj)
bool	Equals (HPS.HCA.NetworkImportOptionsKit in_kit)
override int	GetHashCode ()
	NetworkImportOptionsKit ()
	NetworkImportOptionsKit (HPS.HCA.NetworkImportOptionsKit in_kit)
override HPS.Type	ObjectType ()
void	Set (HPS.HCA.NetworkImportOptionsKit in_kit)
HPS.HCA.NetworkImportOptionsKit	SetEjectedGeometryBoundingPreviews (bool ejected_geometry_bounding_previews)
HPS.HCA.NetworkImportOptionsKit	SetJavascriptPath (string javascript_path)
HPS.HCA.NetworkImportOptionsKit	SetLimitMiB (UInt32 limit_MiB)
HPS.HCA.NetworkImportOptionsKit	SetModelBoundingPreviews (bool model_bounding_previews)
HPS.HCA.NetworkImportOptionsKit	SetNetworkPath (string network_path)
HPS.HCA.NetworkImportOptionsKit	SetTarget (HPS.Model in_target)
HPS.HCA.NetworkImportOptionsKit	SetView (HPS.View in_view)
void	Show (out HPS.HCA.NetworkImportOptionsKit out_kit)
bool	ShowEjectedGeometryBoundingPreviews (out bool out_ejected_geometry_bounding_previews)
bool	ShowJavascriptPath (out string out_javascript_path)
bool	ShowLimitMiB (out UInt32 out_limit_MiB)
bool	ShowModelBoundingPreviews (out bool out_model_bounding_previews)
bool	ShowNetworkPath (out string out_network_path)
bool	ShowTarget (out HPS.Model out_model)
bool	ShowView (out HPS.View out_view)
HPS.HCA.NetworkImportOptionsKit	UnsetEjectedGeometryBoundingPreviews ()
HPS.HCA.NetworkImportOptionsKit	UnsetEverything ()
HPS.HCA.NetworkImportOptionsKit	UnsetJavascriptPath ()
HPS.HCA.NetworkImportOptionsKit	UnsetLimitMiB ()
HPS.HCA.NetworkImportOptionsKit	UnsetModelBoundingPreviews ()
HPS.HCA.NetworkImportOptionsKit	UnsetNetworkPath ()
HPS.HCA.NetworkImportOptionsKit	UnsetTarget ()
HPS.HCA.NetworkImportOptionsKit	UnsetView ()
Public Member Functions inherited from HPS.Sprocket
	Sprocket (HPS.Sprocket in_that)
Public Member Functions inherited from HPS.Object
IntPtr	GetClassID ()
IntPtr	GetInstanceID ()
bool	HasType (HPS.Type in_mask)
	Object (HPS.Object that)
virtual void	Reset ()
virtual HPS.Type	Type ()

Static Public Member Functions
static HPS.HCA.NetworkImportOptionsKit	GetDefault ()
static bool	operator!= (HPS.HCA.NetworkImportOptionsKit a, HPS.HCA.NetworkImportOptionsKit b)
static bool	operator== (HPS.HCA.NetworkImportOptionsKit a, HPS.HCA.NetworkImportOptionsKit b)
Static Public Member Functions inherited from HPS.Object
static IntPtr	ClassID< T > ()

Protected Member Functions
override void	deleteCptr ()
Protected Member Functions inherited from HPS.Object
virtual IntPtr	GetNonDirectorClassID ()

Additional Inherited Members
Protected Attributes inherited from HPS.Object
bool	cMemOwn
HandleRef	cptr

Detailed Description

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.

Constructor & Destructor Documentation

NetworkImportOptionsKit() [1/2]

HPS.HCA.NetworkImportOptionsKit.NetworkImportOptionsKit ( )

inline

The default constructor creates an empty NetworkImportOptionsKit object.

NetworkImportOptionsKit() [2/2]

HPS.HCA.NetworkImportOptionsKit.NetworkImportOptionsKit ( HPS.HCA.NetworkImportOptionsKit  in_kit )

inline

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

Parameters

in_kit

The source NetworkImportOptionsKit to copy.

Member Function Documentation

Empty()

override bool HPS.HCA.NetworkImportOptionsKit.Empty ( )

inlinevirtual

Indicates whether this NetworkImportOptionsKit has any values set on it.

Returns

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

Reimplemented from HPS.Object.

Equals()

bool HPS.HCA.NetworkImportOptionsKit.Equals ( HPS.HCA.NetworkImportOptionsKit  in_kit )

inline

Check if the source NetworkImportOptionsKit is equivalent to this NetworkImportOptionsKit.

Parameters

in_kit

The source NetworkImportOptionsKit to compare to this NetworkImportOptionsKit.

Returns

true if the objects are equivalent, false otherwise.

GetDefault()

static HPS.HCA.NetworkImportOptionsKit HPS.HCA.NetworkImportOptionsKit.GetDefault ( )

inlinestatic

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

void HPS.HCA.NetworkImportOptionsKit.Set ( HPS.HCA.NetworkImportOptionsKit  in_kit )

inline

Copies the source NetworkImportOptionsKit into this NetworkImportOptionsKit.

Parameters

in_kit

The source NetworkImportOptionsKit to copy.

SetEjectedGeometryBoundingPreviews()

HPS.HCA.NetworkImportOptionsKit HPS.HCA.NetworkImportOptionsKit.SetEjectedGeometryBoundingPreviews ( bool  ejected_geometry_bounding_previews )

inline

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

HPS.HCA.NetworkImportOptionsKit HPS.HCA.NetworkImportOptionsKit.SetLimitMiB ( UInt32  limit_MiB )

inline

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

HPS.HCA.NetworkImportOptionsKit HPS.HCA.NetworkImportOptionsKit.SetModelBoundingPreviews ( bool  model_bounding_previews )

inline

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

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

inline

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

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

inline

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

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

inline

Copies this NetworkImportOptionsKit into the given NetworkImportOptionsKit.

Parameters

out_kit

The NetworkImportOptionsKit to populate with the contents of this NetworkImportOptionsKit.

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

out_view

View to use.

Returns

Returns false if a view setting was not specified, false otherwise.

UnsetEjectedGeometryBoundingPreviews()

HPS.HCA.NetworkImportOptionsKit HPS.HCA.NetworkImportOptionsKit.UnsetEjectedGeometryBoundingPreviews ( )

inline

Removes ejected bounding previews setting import setting.

Returns

A reference to this NetworkImportOptionsKit.

UnsetEverything()

HPS.HCA.NetworkImportOptionsKit HPS.HCA.NetworkImportOptionsKit.UnsetEverything ( )

inline

Removes all settings from this NetworkImportOptionsKit.

Returns

A reference to this NetworkImportOptionsKit.

UnsetJavascriptPath()

HPS.HCA.NetworkImportOptionsKit HPS.HCA.NetworkImportOptionsKit.UnsetJavascriptPath ( )

inline

Removes javascript path import setting.

Returns

A reference to this NetworkImportOptionsKit.

UnsetLimitMiB()

HPS.HCA.NetworkImportOptionsKit HPS.HCA.NetworkImportOptionsKit.UnsetLimitMiB ( )

inline

Removes the geometry data memory limit import setting.

Returns

A reference to this NetworkImportOptionsKit.

UnsetModelBoundingPreviews()

HPS.HCA.NetworkImportOptionsKit HPS.HCA.NetworkImportOptionsKit.UnsetModelBoundingPreviews ( )

inline

Removes model bounding previews setting import setting.

Returns

A reference to this NetworkImportOptionsKit.

UnsetNetworkPath()

HPS.HCA.NetworkImportOptionsKit HPS.HCA.NetworkImportOptionsKit.UnsetNetworkPath ( )

inline

Removes network path import setting.

Returns

A reference to this NetworkImportOptionsKit.

UnsetTarget()

HPS.HCA.NetworkImportOptionsKit HPS.HCA.NetworkImportOptionsKit.UnsetTarget ( )

inline

Removes the target import setting.

Returns

A reference to this NetworkImportOptionsKit.

UnsetView()

HPS.HCA.NetworkImportOptionsKit HPS.HCA.NetworkImportOptionsKit.UnsetView ( )

inline

Removes the view import setting.

Returns

A reference to this NetworkImportOptionsKit.

---

The documentation for this class was generated from the following file:

• internals/hps_sprk_hca/source/cs/HPS.HCA.cs