#include <sprk_hca.h>

Static Public Member Functions | |
static ImportOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::HCAImportOptionsKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
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/3]
HPS::HCA::ImportOptionsKit::ImportOptionsKit | ( | ) |
The default constructor creates an empty ImportOptionsKit object.
◆ ImportOptionsKit() [2/3]
HPS::HCA::ImportOptionsKit::ImportOptionsKit | ( | ImportOptionsKit const & | in_kit | ) |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
◆ ImportOptionsKit() [3/3]
HPS::HCA::ImportOptionsKit::ImportOptionsKit | ( | ImportOptionsKit && | in_that | ) |
The move constructor creates an ImportOptionsKit by transferring the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to an ImportOptionsKit to take the impl from.
Member Function Documentation
◆ Empty()
|
virtual |
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 | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
|
static |
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()
|
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::ImportOptionsKit::operator!= | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
ImportOptionsKit& HPS::HCA::ImportOptionsKit::operator= | ( | ImportOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an ImportOptionsKit to take the impl from.
- Returns
- A reference to this ImportOptionsKit.
◆ operator=() [2/2]
ImportOptionsKit& HPS::HCA::ImportOptionsKit::operator= | ( | ImportOptionsKit const & | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
- Returns
- A reference to this ImportOptionsKit.
◆ operator==()
bool HPS::HCA::ImportOptionsKit::operator== | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::HCA::ImportOptionsKit::Set | ( | ImportOptionsKit const & | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
◆ SetEjectedBoundingPreviews()
ImportOptionsKit& 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.
- Parameters
-
ejected_bounding_previews Whether ejected mesh boundings will be streamed.
- Returns
- A reference to this ImportOptionsKit.
◆ SetJavascriptPath()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::SetJavascriptPath | ( | HPS::UTF8 const & | javascript_path | ) |
Use this path to the hc_access.js that will be used.
- Parameters
-
javascript_path Path of the javascript file to use.
- Returns
- A reference to this ImportOptionsKit.
◆ SetLimitMiB()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::SetLimitMiB | ( | uint32_t | limit_MiB | ) |
If non-zero this sets the mesh data memory limit in MiB.
- Parameters
-
limit_MiB Memory in Mib to use.
- Returns
- A reference to this ImportOptionsKit.
◆ SetModelBoundingPreviews()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::SetModelBoundingPreviews | ( | bool | model_bounding_previews | ) |
If true the server will provide model bounding previews at the start of streaming.
- Parameters
-
model_bounding_previews Whether model boundings will be streamed.
- Returns
- A reference to this ImportOptionsKit.
◆ SetNetworkModelName()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::SetNetworkModelName | ( | HPS::UTF8 const & | network_model_name | ) |
A model name that will be passed to the Communicator server. Can be unset with servers with a fixed model.
- Parameters
-
network_model_name Model name to use.
- Returns
- A reference to this ImportOptionsKit.
◆ SetNetworkPath()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::SetNetworkPath | ( | HPS::UTF8 const & | network_path | ) |
A URL that will be used to connect to the Communicator server.
- Parameters
-
network_path URL to use.
- Returns
- A reference to this ImportOptionsKit.
◆ SetTarget()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::SetTarget | ( | HPS::Model const & | in_target | ) |
Uses this Model to set the root segment, library segment, and portfolio where the data will be imported.
- Parameters
-
in_model Model to use.
- Returns
- A reference to this ImportOptionsKit.
◆ SetView()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::SetView | ( | HPS::View const & | in_view | ) |
Uses the View to interact with the camera.
- Parameters
-
in_view View to use for camera tracking.
- Returns
- A reference to this ImportOptionsKit.
◆ Show()
void HPS::HCA::ImportOptionsKit::Show | ( | ImportOptionsKit & | out_kit | ) | const |
Copies this ImportOptionsKit into the given ImportOptionsKit.
- Parameters
-
out_kit The ImportOptionsKit to populate with the contents of this ImportOptionsKit.
◆ ShowEjectedBoundingPreviews()
bool HPS::HCA::ImportOptionsKit::ShowEjectedBoundingPreviews | ( | bool & | out_ejected_bounding_previews | ) | const |
Shows if the server will provide ejected bounding previews.
- Parameters
-
out_ejected_bounding_previews True if boundings shall be streamed.
- Returns
- Returns false if not set, false otherwise.
◆ ShowJavascriptPath()
bool HPS::HCA::ImportOptionsKit::ShowJavascriptPath | ( | HPS::UTF8 & | out_javascript_path | ) | const |
Shows the path to the hc_access.js that will be used.
- Parameters
-
out_javascript_path The path.
- Returns
- Returns false if there is no path, false otherwise.
◆ ShowLimitMiB()
bool HPS::HCA::ImportOptionsKit::ShowLimitMiB | ( | uint32_t & | out_limit_MiB | ) | const |
Shows the mesh data memory limit in MiB.
- Parameters
-
out_limit_MiB Memory in Mib to use.
- Returns
- Returns false if not set, false otherwise.
◆ ShowModelBoundingPreviews()
bool HPS::HCA::ImportOptionsKit::ShowModelBoundingPreviews | ( | bool & | out_model_bounding_previews | ) | const |
Shows if the server will provide model bounding previews at the start of streaming.
- Parameters
-
out_model_bounding_previews True if boundings shall be streamed.
- Returns
- Returns false if not set, false otherwise.
◆ ShowNetworkModelName()
bool HPS::HCA::ImportOptionsKit::ShowNetworkModelName | ( | HPS::UTF8 & | out_network_model_name | ) | const |
Shows the model name that will be used to connect to the Communicator server.
- Parameters
-
out_network_model_name The name.
- Returns
- Returns false if there is no model name, false otherwise.
◆ ShowNetworkPath()
bool HPS::HCA::ImportOptionsKit::ShowNetworkPath | ( | HPS::UTF8 & | out_network_path | ) | const |
Shows the URL that will be used to connect to the Communicator server.
- Parameters
-
out_network_path The path.
- Returns
- Returns false if there is no path, false otherwise.
◆ ShowTarget()
bool HPS::HCA::ImportOptionsKit::ShowTarget | ( | HPS::Model & | out_model | ) | const |
Shows the model where the data will be imported.
- Parameters
-
out_model Model 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 | ( | HPS::View & | out_view | ) | const |
Shows the view that will be used.
- Parameters
-
out_view View to use.
- Returns
- Returns false if there is no view, false otherwise.
◆ UnsetEjectedBoundingPreviews()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::UnsetEjectedBoundingPreviews | ( | ) |
Removes ejected bounding previews setting.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetEverything()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ImportOptionsKit.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetJavascriptPath()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::UnsetJavascriptPath | ( | ) |
Removes javascript path.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetLimitMiB()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::UnsetLimitMiB | ( | ) |
Removes the mesh data memory limit.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetModelBoundingPreviews()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::UnsetModelBoundingPreviews | ( | ) |
Removes model bounding previews setting.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetNetworkModelName()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::UnsetNetworkModelName | ( | ) |
Removes network model name.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetNetworkPath()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::UnsetNetworkPath | ( | ) |
Removes network path.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetTarget()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::UnsetTarget | ( | ) |
Removes the target model.
- Returns
- A reference to this ImportOptionsKit.
◆ UnsetView()
ImportOptionsKit& HPS::HCA::ImportOptionsKit::UnsetView | ( | ) |
Removes the view.
- Returns
- A reference to this ImportOptionsKit.
The documentation for this class was generated from the following file:
- include/sprk_hca.h