#include <sprk_hca.h>

Inheritance diagram for HPS::HCA::NetworkImportOptionsKit:
HPS::Sprocket HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (NetworkImportOptionsKit const &in_kit) const
 
 NetworkImportOptionsKit ()
 
 NetworkImportOptionsKit (NetworkImportOptionsKit const &in_kit)
 
 NetworkImportOptionsKit (NetworkImportOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (NetworkImportOptionsKit const &in_kit) const
 
NetworkImportOptionsKitoperator= (NetworkImportOptionsKit &&in_that)
 
NetworkImportOptionsKitoperator= (NetworkImportOptionsKit const &in_kit)
 
bool operator== (NetworkImportOptionsKit const &in_kit) const
 
void Set (NetworkImportOptionsKit const &in_kit)
 
NetworkImportOptionsKitSetEjectedGeometryBoundingPreviews (bool ejected_geometry_bounding_previews)
 
NetworkImportOptionsKitSetJavascriptPath (HPS::UTF8 const &javascript_path)
 
NetworkImportOptionsKitSetLimitMiB (uint32_t limit_MiB)
 
NetworkImportOptionsKitSetModelBoundingPreviews (bool model_bounding_previews)
 
NetworkImportOptionsKitSetNetworkPath (HPS::UTF8 const &network_path)
 
NetworkImportOptionsKitSetTarget (HPS::Model const &in_target)
 
NetworkImportOptionsKitSetView (HPS::View const &in_view)
 
void Show (NetworkImportOptionsKit &out_kit) const
 
bool ShowEjectedGeometryBoundingPreviews (bool &out_ejected_geometry_bounding_previews) const
 
bool ShowJavascriptPath (HPS::UTF8 &out_javascript_path) const
 
bool ShowLimitMiB (uint32_t &out_limit_MiB) const
 
bool ShowModelBoundingPreviews (bool &out_model_bounding_previews) const
 
bool ShowNetworkPath (HPS::UTF8 &out_network_path) const
 
bool ShowTarget (HPS::Model &out_model) const
 
bool ShowView (HPS::View &out_view) const
 
NetworkImportOptionsKitUnsetEjectedGeometryBoundingPreviews ()
 
NetworkImportOptionsKitUnsetEverything ()
 
NetworkImportOptionsKitUnsetJavascriptPath ()
 
NetworkImportOptionsKitUnsetLimitMiB ()
 
NetworkImportOptionsKitUnsetModelBoundingPreviews ()
 
NetworkImportOptionsKitUnsetNetworkPath ()
 
NetworkImportOptionsKitUnsetTarget ()
 
NetworkImportOptionsKitUnsetView ()
 
- Public Member Functions inherited from HPS::Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Member Functions

static NetworkImportOptionsKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::HCANetworkImportOptionsKit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

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/3]

HPS::HCA::NetworkImportOptionsKit::NetworkImportOptionsKit ( )

The default constructor creates an empty NetworkImportOptionsKit object.

◆ NetworkImportOptionsKit() [2/3]

HPS::HCA::NetworkImportOptionsKit::NetworkImportOptionsKit ( NetworkImportOptionsKit const &  in_kit)

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

Parameters
in_kitThe source NetworkImportOptionsKit to copy.

◆ NetworkImportOptionsKit() [3/3]

HPS::HCA::NetworkImportOptionsKit::NetworkImportOptionsKit ( NetworkImportOptionsKit &&  in_that)

The move constructor creates an NetworkImportOptionsKit by transferring the underlying impl of the rvalue reference to this NetworkImportOptionsKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to an NetworkImportOptionsKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::HCA::NetworkImportOptionsKit::Empty ( ) const
virtual

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 ( NetworkImportOptionsKit const &  in_kit) const

Check if the source NetworkImportOptionsKit is equivalent to this NetworkImportOptionsKit.

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

◆ GetDefault()

static NetworkImportOptionsKit HPS::HCA::NetworkImportOptionsKit::GetDefault ( )
static

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

HPS::Type HPS::HCA::NetworkImportOptionsKit::ObjectType ( ) const
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.

◆ operator!=()

bool HPS::HCA::NetworkImportOptionsKit::operator!= ( NetworkImportOptionsKit const &  in_kit) const

Check if the source NetworkImportOptionsKit is not equivalent to this NetworkImportOptionsKit.

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

◆ operator=() [1/2]

NetworkImportOptionsKit& HPS::HCA::NetworkImportOptionsKit::operator= ( NetworkImportOptionsKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this NetworkImportOptionsKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to an NetworkImportOptionsKit to take the impl from.
Returns
A reference to this NetworkImportOptionsKit.

◆ operator=() [2/2]

NetworkImportOptionsKit& HPS::HCA::NetworkImportOptionsKit::operator= ( NetworkImportOptionsKit const &  in_kit)

Copies the source NetworkImportOptionsKit into this NetworkImportOptionsKit.

Parameters
in_kitThe source NetworkImportOptionsKit to copy.
Returns
A reference to this NetworkImportOptionsKit.

◆ operator==()

bool HPS::HCA::NetworkImportOptionsKit::operator== ( NetworkImportOptionsKit const &  in_kit) const

Check if the source NetworkImportOptionsKit is equivalent to this NetworkImportOptionsKit.

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

◆ Set()

void HPS::HCA::NetworkImportOptionsKit::Set ( NetworkImportOptionsKit const &  in_kit)

Copies the source NetworkImportOptionsKit into this NetworkImportOptionsKit.

Parameters
in_kitThe source NetworkImportOptionsKit to copy.

◆ SetEjectedGeometryBoundingPreviews()

NetworkImportOptionsKit& 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.

Parameters
ejected_geometry_bounding_previewsWhether ejected geometry should be replaced with boundings.
Returns
A reference to this NetworkImportOptionsKit.

◆ SetJavascriptPath()

NetworkImportOptionsKit& HPS::HCA::NetworkImportOptionsKit::SetJavascriptPath ( HPS::UTF8 const &  javascript_path)

Sets the path to hc_access.js which will be used during the import. Setting a Javascript Path is required for the import to succeed. The hc_access.js file is provided with HOOPS Visualize.

Parameters
javascript_pathPath of the javascript file to use.
Returns
A reference to this NetworkImportOptionsKit.

◆ SetLimitMiB()

NetworkImportOptionsKit& HPS::HCA::NetworkImportOptionsKit::SetLimitMiB ( uint32_t  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.

Parameters
limit_MiBMemory in Megabytes to use for geometry data.
Returns
A reference to this NetworkImportOptionsKit.

◆ SetModelBoundingPreviews()

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.

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

◆ SetNetworkPath()

NetworkImportOptionsKit& HPS::HCA::NetworkImportOptionsKit::SetNetworkPath ( HPS::UTF8 const &  network_path)

Sets the URL that will be used to connect to the Communicator server. The Network Path is required when importing a file over the network.

Parameters
network_pathURL to use.
Returns
A reference to this ImportOptionsKit.

◆ SetTarget()

NetworkImportOptionsKit& HPS::HCA::NetworkImportOptionsKit::SetTarget ( HPS::Model const &  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.

Parameters
in_modelModel to use.
Returns
A reference to this NetworkImportOptionsKit.

◆ SetView()

NetworkImportOptionsKit& HPS::HCA::NetworkImportOptionsKit::SetView ( HPS::View const &  in_view)

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

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

◆ Show()

void HPS::HCA::NetworkImportOptionsKit::Show ( NetworkImportOptionsKit out_kit) const

Copies this NetworkImportOptionsKit into the given NetworkImportOptionsKit.

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

◆ ShowEjectedGeometryBoundingPreviews()

bool HPS::HCA::NetworkImportOptionsKit::ShowEjectedGeometryBoundingPreviews ( bool &  out_ejected_geometry_bounding_previews) const

Shows the ejected bounding previews import setting.

Parameters
out_ejected_geometry_bounding_previewsWhether 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 ( HPS::UTF8 out_javascript_path) const

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

Parameters
out_javascript_pathThe 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 ( uint32_t &  out_limit_MiB) const

Shows the memory limit import setting.

Parameters
out_limit_MiBThe 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 ( bool &  out_model_bounding_previews) const

Shows the model bounding preview import setting.

Parameters
out_model_bounding_previewsWhether 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 ( HPS::UTF8 out_network_path) const

Shows the network path import setting.

Parameters
out_network_pathThe 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 ( HPS::Model out_model) const

Shows the target import setting.

Parameters
out_modelModel 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 ( HPS::View out_view) const

Shows the view import setting.

Parameters
out_viewView to use.
Returns
Returns false if a view setting was not specified, false otherwise.

◆ UnsetEjectedGeometryBoundingPreviews()

NetworkImportOptionsKit& HPS::HCA::NetworkImportOptionsKit::UnsetEjectedGeometryBoundingPreviews ( )

Removes ejected bounding previews setting import setting.

Returns
A reference to this NetworkImportOptionsKit.

◆ UnsetEverything()

NetworkImportOptionsKit& HPS::HCA::NetworkImportOptionsKit::UnsetEverything ( )

Removes all settings from this NetworkImportOptionsKit.

Returns
A reference to this NetworkImportOptionsKit.

◆ UnsetJavascriptPath()

NetworkImportOptionsKit& HPS::HCA::NetworkImportOptionsKit::UnsetJavascriptPath ( )

Removes javascript path import setting.

Returns
A reference to this NetworkImportOptionsKit.

◆ UnsetLimitMiB()

NetworkImportOptionsKit& HPS::HCA::NetworkImportOptionsKit::UnsetLimitMiB ( )

Removes the geometry data memory limit import setting.

Returns
A reference to this NetworkImportOptionsKit.

◆ UnsetModelBoundingPreviews()

NetworkImportOptionsKit& HPS::HCA::NetworkImportOptionsKit::UnsetModelBoundingPreviews ( )

Removes model bounding previews setting import setting.

Returns
A reference to this NetworkImportOptionsKit.

◆ UnsetNetworkPath()

NetworkImportOptionsKit& HPS::HCA::NetworkImportOptionsKit::UnsetNetworkPath ( )

Removes network path import setting.

Returns
A reference to this NetworkImportOptionsKit.

◆ UnsetTarget()

NetworkImportOptionsKit& HPS::HCA::NetworkImportOptionsKit::UnsetTarget ( )

Removes the target import setting.

Returns
A reference to this NetworkImportOptionsKit.

◆ UnsetView()

NetworkImportOptionsKit& HPS::HCA::NetworkImportOptionsKit::UnsetView ( )

Removes the view import setting.

Returns
A reference to this NetworkImportOptionsKit.

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