More...

Inheritance diagram for HPS.HCA.ImportOptionsKit:
HPS.Sprocket HPS.Object

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...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
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 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 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]

HPS.HCA.ImportOptionsKit.ImportOptionsKit ( )
inline

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/2]

HPS.HCA.ImportOptionsKit.ImportOptionsKit ( HPS.HCA.ImportOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ImportOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.HCA.ImportOptionsKit.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()

bool HPS.HCA.ImportOptionsKit.Equals ( HPS.HCA.ImportOptionsKit  in_kit)
inline

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.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()

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

void HPS.HCA.ImportOptionsKit.Set ( HPS.HCA.ImportOptionsKit  in_kit)
inline

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ SetEjectedBoundingPreviews()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.SetEjectedBoundingPreviews ( bool  ejected_bounding_previews)
inline

If true the server will provide bounding previews where meshes are ejected because of the memory limits.

Parameters
ejected_bounding_previewsWhether ejected mesh boundings will be streamed.
Returns
A reference to this ImportOptionsKit.

◆ SetLimitMiB()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.SetLimitMiB ( UInt32  limit_MiB)
inline

If non-zero this sets the mesh data memory limit in MiB.

Parameters
limit_MiBMemory in Mib to use.
Returns
A reference to this ImportOptionsKit.

◆ SetModelBoundingPreviews()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.SetModelBoundingPreviews ( bool  model_bounding_previews)
inline

If true the server will provide model bounding previews at the start of streaming.

Parameters
model_bounding_previewsWhether model boundings will be streamed.
Returns
A reference to this ImportOptionsKit.

◆ SetTarget()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.SetTarget ( HPS.Model  in_target)
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()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.SetView ( HPS.View  in_view)
inline

Uses the View to interact with the camera.

Parameters
in_viewView to use for camera tracking.
Returns
A reference to this ImportOptionsKit.

◆ Show()

void HPS.HCA.ImportOptionsKit.Show ( out HPS.HCA.ImportOptionsKit  out_kit)
inline

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters
out_kitThe ImportOptionsKit to populate with the contents of this ImportOptionsKit.

◆ ShowEjectedBoundingPreviews()

bool HPS.HCA.ImportOptionsKit.ShowEjectedBoundingPreviews ( out bool  out_ejected_bounding_previews)
inline

Shows if the server will provide ejected bounding previews.

Parameters
out_ejected_bounding_previewsTrue if boundings shall be streamed.
Returns
Returns false if not set, false otherwise.

◆ ShowJavascriptPath()

bool HPS.HCA.ImportOptionsKit.ShowJavascriptPath ( out string  out_javascript_path)
inline

Shows the path to the hc_access.js that will be used.

Parameters
out_javascript_pathThe path.
Returns
Returns false if there is no path, false otherwise.

◆ ShowLimitMiB()

bool HPS.HCA.ImportOptionsKit.ShowLimitMiB ( out UInt32  out_limit_MiB)
inline

Shows the mesh data memory limit in MiB.

Parameters
out_limit_MiBMemory in Mib to use.
Returns
Returns false if not set, false otherwise.

◆ ShowModelBoundingPreviews()

bool HPS.HCA.ImportOptionsKit.ShowModelBoundingPreviews ( out bool  out_model_bounding_previews)
inline

Shows if the server will provide model bounding previews at the start of streaming.

Parameters
out_model_bounding_previewsTrue if boundings shall be streamed.
Returns
Returns false if not set, false otherwise.

◆ ShowNetworkModelName()

bool HPS.HCA.ImportOptionsKit.ShowNetworkModelName ( out string  out_network_model_name)
inline

Shows the model name that will be used to connect to the Communicator server.

Parameters
out_network_model_nameThe name.
Returns
Returns false if there is no model name, false otherwise.

◆ ShowNetworkPath()

bool HPS.HCA.ImportOptionsKit.ShowNetworkPath ( out string  out_network_path)
inline

Shows the URL that will be used to connect to the Communicator server.

Parameters
out_network_pathThe path.
Returns
Returns false if there is no path, false otherwise.

◆ ShowTarget()

bool HPS.HCA.ImportOptionsKit.ShowTarget ( out HPS.Model  out_model)
inline

Shows the model where the data will be imported.

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

bool HPS.HCA.ImportOptionsKit.ShowView ( out HPS.View  out_view)
inline

Shows the view that will be used.

Parameters
out_viewView to use.
Returns
Returns false if there is no view, false otherwise.

◆ UnsetEjectedBoundingPreviews()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.UnsetEjectedBoundingPreviews ( )
inline

Removes ejected bounding previews setting.

Returns
A reference to this ImportOptionsKit.

◆ UnsetEverything()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.

◆ UnsetJavascriptPath()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.UnsetJavascriptPath ( )
inline

Removes javascript path.

Returns
A reference to this ImportOptionsKit.

◆ UnsetLimitMiB()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.UnsetLimitMiB ( )
inline

Removes the mesh data memory limit.

Returns
A reference to this ImportOptionsKit.

◆ UnsetModelBoundingPreviews()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.UnsetModelBoundingPreviews ( )
inline

Removes model bounding previews setting.

Returns
A reference to this ImportOptionsKit.

◆ UnsetNetworkModelName()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.UnsetNetworkModelName ( )
inline

Removes network model name.

Returns
A reference to this ImportOptionsKit.

◆ UnsetNetworkPath()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.UnsetNetworkPath ( )
inline

Removes network path.

Returns
A reference to this ImportOptionsKit.

◆ UnsetTarget()

HPS.HCA.ImportOptionsKit HPS.HCA.ImportOptionsKit.UnsetTarget ( )
inline

Removes the target model.

Returns
A reference to this ImportOptionsKit.

◆ UnsetView()

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