The HPS::Stream::ExportOptionsKit class contains settings controlling the export of HSF files. More...
#include <hps.h>
Public Member Functions | |
ExportOptionsKit () | |
The default constructor creates an empty ExportOptionsKit object. More... | |
ExportOptionsKit (ExportOptionsKit const &in_kit) | |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit. More... | |
ExportOptionsKit (ExportOptionsKit &&in_that) | |
The move constructor creates an ExportOptionsKit by transferring the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy and allocation. More... | |
ExportOptionsKit & | operator= (ExportOptionsKit &&in_that) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy. More... | |
virtual | ~ExportOptionsKit () |
HPS::Type | ObjectType () const |
void | Set (ExportOptionsKit const &in_kit) |
Copies the source ExportOptionsKit into this ExportOptionsKit. More... | |
void | Show (ExportOptionsKit &out_kit) const |
Copies this ExportOptionsKit into the given ExportOptionsKit. More... | |
ExportOptionsKit & | operator= (ExportOptionsKit const &in_kit) |
Copies the source ExportOptionsKit into this ExportOptionsKit. More... | |
bool | Empty () const |
Indicates whether this ExportOptionsKit has any values set on it. More... | |
bool | Equals (ExportOptionsKit const &in_kit) const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More... | |
bool | operator== (ExportOptionsKit const &in_kit) const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More... | |
bool | operator!= (ExportOptionsKit const &in_kit) const |
Check if the source ExportOptionsKit is not equivalent to this ExportOptionsKit. More... | |
ExportOptionsKit & | SetToolkit (Toolkit const &in_toolkit) |
Sets the toolkit used for the export process. More... | |
ExportOptionsKit & | SetDefaultCamera (CameraKit const &in_camera) |
Sets the default camera used for the export process. More... | |
ExportOptionsKit & | SetVertexCompression (bool in_state, unsigned int in_bits_per_vertex=24) |
Sets vertex compression state and maximum number of bits to use for each (x,y,z) vertex. More... | |
ExportOptionsKit & | SetNormalCompression (bool in_state, unsigned int in_bits_per_normal=10) |
Sets normal compression state and maximum number of bits to use for each (x,y,z) normal. More... | |
ExportOptionsKit & | SetParameterCompression (bool in_state, unsigned int in_bits_per_parameter=8) |
Sets vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter. More... | |
ExportOptionsKit & | SetColorCompression (bool in_state, unsigned int in_bits_per_color=24) |
Sets color compression state and maximum number of bits to use for each (r,g,b) color. More... | |
ExportOptionsKit & | SetIndexCompression (bool in_state, unsigned int in_bits_per_index=8) |
Sets color index compression state and maximum number of bits to use for each float index. More... | |
ExportOptionsKit & | SetConnectivityCompression (bool in_state) |
Sets connectivity (face list) compression state. More... | |
ExportOptionsKit & | SetSerializeTristrips (bool in_state) |
Sets tristrips serialization state. More... | |
ExportOptionsKit & | SetImageCompression (bool in_state, float in_quality=0.75f) |
Sets image compression state for uncompressed images in segment tree. More... | |
ExportOptionsKit & | UnsetToolkit () |
Removes the toolkit used for the export process. More... | |
ExportOptionsKit & | UnsetDefaultCamera () |
Removes the default camera used for the export process. More... | |
ExportOptionsKit & | UnsetVertexCompression () |
Removes vertex compression state and maximum number of bits to use for each (x,y,z) vertex. More... | |
ExportOptionsKit & | UnsetNormalCompression () |
Removes normal compression state and maximum number of bits to use for each (x,y,z) normal. More... | |
ExportOptionsKit & | UnsetParameterCompression () |
Removes vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter. More... | |
ExportOptionsKit & | UnsetColorCompression () |
Removes color compression state and maximum number of bits to use for each (r,g,b) color. More... | |
ExportOptionsKit & | UnsetIndexCompression () |
Removes color index compression state and maximum number of bits to use for each float index. More... | |
ExportOptionsKit & | UnsetConnectivityCompression () |
Removes connectivity (face list) compression state. More... | |
ExportOptionsKit & | UnsetImageCompression () |
Removes image compression state for uncompressed images in segment tree. More... | |
ExportOptionsKit & | UnsetSerializeTristrips () |
Removes tristrips serialization state. More... | |
ExportOptionsKit & | UnsetEverything () |
Removes all settings from this ExportOptionsKit. More... | |
bool | ShowToolkit (HPS::Stream::Toolkit &out_toolkit) const |
Shows the root toolkit used for the export process. More... | |
bool | ShowDefaultCamera (CameraKit &out_camera) const |
Shows the default camera used for the export process. More... | |
bool | ShowVertexCompression (bool &out_state, unsigned int &out_bits_per_vertex) const |
Shows vertex compression state and maximum number of bits to use for each (x,y,z) vertex. More... | |
bool | ShowNormalCompression (bool &out_state, unsigned int &out_bits_per_normal) const |
Shows normal compression state and maximum number of bits to use for each (x,y,z) normal. More... | |
bool | ShowParameterCompression (bool &out_state, unsigned int &out_bits_per_parameter) const |
Shows vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter. More... | |
bool | ShowColorCompression (bool &out_state, unsigned int &out_bits_per_color) const |
Shows color compression state and maximum number of bits to use for each (r,g,b) color. More... | |
bool | ShowIndexCompression (bool &out_state, unsigned int &out_bits_per_index) const |
Shows color index compression state and maximum number of bits to use for each float index. More... | |
bool | ShowConnectivityCompression (bool &out_state) const |
Shows connectivity (face list) compression state. More... | |
bool | ShowImageCompression (bool &out_state, float &out_quality) const |
Shows image compression state for uncompressed images in segment tree. More... | |
bool | ShowSerializeTristrips (bool &out_state) const |
Shows tristrips serialization state. More... | |
ExportOptionsKit & | SetEventHandler (HPS::Stream::ExportEventHandler &in_handler, intptr_t in_type) |
Sets the specified ExportEventHandler for the indicated ExportEvent type. More... | |
ExportOptionsKit & | UnsetEventHandler (intptr_t in_type) |
Unsets the ExportEventHandler for the indicated ExportEvent type. More... | |
ExportOptionsKit & | UnsetEventHandlers () |
Unsets the ExportEventHandler for all ExportEvent types. More... | |
virtual HPS::Type | Type () const |
This function returns the true type of the underlying object. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS::Type in_mask) const |
This function indicates whether this Object has the given Type mask. More... | |
intptr_t | GetClassID () const |
Returns a unique identifier that is shared by all objects of the same class. More... | |
intptr_t | GetInstanceID () const |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
Static Public Member Functions | |
static ExportOptionsKit | GetDefault () |
Creates a ExportOptionsKit which contains the default settings. More... | |
template<typename T > | |
static intptr_t | ClassID () |
Unique identifier for this class. More... | |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::StreamExportOptionsKit |
The HPS::Stream::ExportOptionsKit class contains settings controlling the export of HSF files.
Calling HPS::Stream::ExportOptionsKit::GetDefault() will return an options kit with values found in this table.
HPS::Stream::ExportOptionsKit::ExportOptionsKit | ( | ) |
The default constructor creates an empty ExportOptionsKit object.
HPS::Stream::ExportOptionsKit::ExportOptionsKit | ( | ExportOptionsKit const & | in_kit | ) |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit.
in_kit | The source ExportOptionsKit to copy. |
HPS::Stream::ExportOptionsKit::ExportOptionsKit | ( | ExportOptionsKit && | in_that | ) |
The move constructor creates an ExportOptionsKit by transferring the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy and allocation.
in_that | An rvalue reference to an ExportOptionsKit to take the impl from. |
|
virtual |
|
inlinestaticinherited |
Unique identifier for this class.
Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.
|
virtual |
Indicates whether this ExportOptionsKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::Stream::ExportOptionsKit::Equals | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
in_kit | The source ExportOptionsKit to compare to this ExportOptionsKit. |
|
inherited |
Returns a unique identifier that is shared by all objects of the same class.
|
static |
Creates a ExportOptionsKit 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.
|
inherited |
Returns an identifier that can be used to identify which instance of a class an object is.
Different keys and controls will return the same value if they are backed by the same database resource.
|
inherited |
|
inlinevirtual |
bool HPS::Stream::ExportOptionsKit::operator!= | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is not equivalent to this ExportOptionsKit.
in_kit | The source ExportOptionsKit to compare to this ExportOptionsKit. |
ExportOptionsKit& HPS::Stream::ExportOptionsKit::operator= | ( | ExportOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy.
in_that | An rvalue reference to an ExportOptionsKit to take the impl from. |
ExportOptionsKit& HPS::Stream::ExportOptionsKit::operator= | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
in_kit | The source ExportOptionsKit to copy. |
bool HPS::Stream::ExportOptionsKit::operator== | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
in_kit | The source ExportOptionsKit to compare to this ExportOptionsKit. |
|
virtualinherited |
Resets this object to its initial, uninitialized state.
Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.
void HPS::Stream::ExportOptionsKit::Set | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
in_kit | The source ExportOptionsKit to copy. |
ExportOptionsKit& HPS::Stream::ExportOptionsKit::SetColorCompression | ( | bool | in_state, |
unsigned int | in_bits_per_color = 24 |
||
) |
Sets color compression state and maximum number of bits to use for each (r,g,b) color.
Defaults to no compression.
in_state | Whether color compression is enabled or not. |
in_bits_per_color | Number of bits to use per color when performing color compression. Value must be in the range [0, 72]. Defaults to 24. |
ExportOptionsKit& HPS::Stream::ExportOptionsKit::SetConnectivityCompression | ( | bool | in_state | ) |
Sets connectivity (face list) compression state.
Defaults to no compression.
in_state | Whether color index compression is enabled or not. |
ExportOptionsKit& HPS::Stream::ExportOptionsKit::SetDefaultCamera | ( | CameraKit const & | in_camera | ) |
Sets the default camera used for the export process.
If no camera is specified, no default camera will be used during export.
in_camera | The camera to apply as default. |
ExportOptionsKit& HPS::Stream::ExportOptionsKit::SetEventHandler | ( | HPS::Stream::ExportEventHandler & | in_handler, |
intptr_t | in_type | ||
) |
Sets the specified ExportEventHandler for the indicated ExportEvent type.
in_handler | An ExportEventHandler to be set. |
in_type | The type of the Stream ExportEvent for which the given event handler will be used. |
ExportOptionsKit& HPS::Stream::ExportOptionsKit::SetImageCompression | ( | bool | in_state, |
float | in_quality = 0.75f |
||
) |
Sets image compression state for uncompressed images in segment tree.
Defaults to no compression, though the images will be converted to lossless PNG data within the file.
in_state | Whether to compress uncompressed images. If false, uncompressed images will be exported as lossless PNG, if true, they are exported as JPEG with the specified quality. |
in_quality | Float in the range [0,1] indicating the quality of the JPEG image. Defaults to 0.75f. |
ExportOptionsKit& HPS::Stream::ExportOptionsKit::SetIndexCompression | ( | bool | in_state, |
unsigned int | in_bits_per_index = 8 |
||
) |
Sets color index compression state and maximum number of bits to use for each float index.
Defaults to no compression.
in_state | Whether color index compression is enabled or not. |
in_bits_per_index | Number of bits to use per index when performing color index compression. Value must be in the range [0, 24]. Defaults to 8. |
ExportOptionsKit& HPS::Stream::ExportOptionsKit::SetNormalCompression | ( | bool | in_state, |
unsigned int | in_bits_per_normal = 10 |
||
) |
Sets normal compression state and maximum number of bits to use for each (x,y,z) normal.
Defaults to no compression.
in_state | Whether normal compression is enabled or not. |
in_bits_per_normal | Number of bits to use per normal when performing normal compression. Value must be in the range [0, 72]. Defaults to 10. |
ExportOptionsKit& HPS::Stream::ExportOptionsKit::SetParameterCompression | ( | bool | in_state, |
unsigned int | in_bits_per_parameter = 8 |
||
) |
Sets vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter.
Defaults to no compression.
in_state | Whether parameter compression is enabled or not. |
in_bits_per_parameter | Number of bits to use per parameter when performing parameter compression. Value must be in the range [0, 24]. Defaults to 8. |
ExportOptionsKit& HPS::Stream::ExportOptionsKit::SetSerializeTristrips | ( | bool | in_state | ) |
Sets tristrips serialization state.
Defaults to tristrips are serialized.
in_state | Whether tristrips serialization is enabled or not. |
ExportOptionsKit& HPS::Stream::ExportOptionsKit::SetToolkit | ( | Toolkit const & | in_toolkit | ) |
Sets the toolkit used for the export process.
If no toolkit is specified, a default tookit will be used during export.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::SetVertexCompression | ( | bool | in_state, |
unsigned int | in_bits_per_vertex = 24 |
||
) |
Sets vertex compression state and maximum number of bits to use for each (x,y,z) vertex.
Defaults to no compression.
in_state | Whether vertex compression is enabled or not. |
in_bits_per_vertex | Number of bits to use per vertex when performing vertex compression. Value must be in the range [0, 72]. Defaults to 24. |
void HPS::Stream::ExportOptionsKit::Show | ( | ExportOptionsKit & | out_kit | ) | const |
Copies this ExportOptionsKit into the given ExportOptionsKit.
out_kit | The ExportOptionsKit to populate with the contents of this ExportOptionsKit. |
bool HPS::Stream::ExportOptionsKit::ShowColorCompression | ( | bool & | out_state, |
unsigned int & | out_bits_per_color | ||
) | const |
Shows color compression state and maximum number of bits to use for each (r,g,b) color.
out_state | Whether color compression is enabled or not. |
out_bits_per_color | Number of bits to use per color when performing color compression. |
bool HPS::Stream::ExportOptionsKit::ShowConnectivityCompression | ( | bool & | out_state | ) | const |
Shows connectivity (face list) compression state.
out_state | Whether connectivity compression is enabled or not. |
bool HPS::Stream::ExportOptionsKit::ShowDefaultCamera | ( | CameraKit & | out_camera | ) | const |
Shows the default camera used for the export process.
out_camera | The camera being used as default. |
bool HPS::Stream::ExportOptionsKit::ShowImageCompression | ( | bool & | out_state, |
float & | out_quality | ||
) | const |
Shows image compression state for uncompressed images in segment tree.
out_state | Whether image compression is enabled or not. |
out_quality | Float in the range [0,1] indicating the quality of the JPEG image. |
bool HPS::Stream::ExportOptionsKit::ShowIndexCompression | ( | bool & | out_state, |
unsigned int & | out_bits_per_index | ||
) | const |
Shows color index compression state and maximum number of bits to use for each float index.
out_state | Whether color index compression is enabled or not. |
out_bits_per_index | Number of bits to use per index when performing color index compression. |
bool HPS::Stream::ExportOptionsKit::ShowNormalCompression | ( | bool & | out_state, |
unsigned int & | out_bits_per_normal | ||
) | const |
Shows normal compression state and maximum number of bits to use for each (x,y,z) normal.
out_state | Whether normal compression is enabled or not. |
out_bits_per_normal | Number of bits to use per normal when performing normal compression. |
bool HPS::Stream::ExportOptionsKit::ShowParameterCompression | ( | bool & | out_state, |
unsigned int & | out_bits_per_parameter | ||
) | const |
Shows vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter.
out_state | Whether parameter compression is enabled or not. |
out_bits_per_parameter | Number of bits to use per parameter when performing parameter compression. |
bool HPS::Stream::ExportOptionsKit::ShowSerializeTristrips | ( | bool & | out_state | ) | const |
Shows tristrips serialization state.
out_state | Whether tristrips serialization is enabled or not. |
bool HPS::Stream::ExportOptionsKit::ShowToolkit | ( | HPS::Stream::Toolkit & | out_toolkit | ) | const |
Shows the root toolkit used for the export process.
out_toolkit | The Toolkit used for the export process. |
bool HPS::Stream::ExportOptionsKit::ShowVertexCompression | ( | bool & | out_state, |
unsigned int & | out_bits_per_vertex | ||
) | const |
Shows vertex compression state and maximum number of bits to use for each (x,y,z) vertex.
out_state | Whether vertex compression is enabled or not. |
out_bits_per_vertex | Number of bits to use per vertex when performing vertex compression. |
|
inlinevirtualinherited |
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.
Reimplemented from HPS::Object.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetColorCompression | ( | ) |
Removes color compression state and maximum number of bits to use for each (r,g,b) color.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetConnectivityCompression | ( | ) |
Removes connectivity (face list) compression state.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetDefaultCamera | ( | ) |
Removes the default camera used for the export process.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetEventHandler | ( | intptr_t | in_type | ) |
Unsets the ExportEventHandler for the indicated ExportEvent type.
in_type | The type of the Stream ExportEvent to unset. |
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetEventHandlers | ( | ) |
Unsets the ExportEventHandler for all ExportEvent types.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportOptionsKit.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetImageCompression | ( | ) |
Removes image compression state for uncompressed images in segment tree.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetIndexCompression | ( | ) |
Removes color index compression state and maximum number of bits to use for each float index.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetNormalCompression | ( | ) |
Removes normal compression state and maximum number of bits to use for each (x,y,z) normal.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetParameterCompression | ( | ) |
Removes vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetSerializeTristrips | ( | ) |
Removes tristrips serialization state.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetToolkit | ( | ) |
Removes the toolkit used for the export process.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetVertexCompression | ( | ) |
Removes vertex compression state and maximum number of bits to use for each (x,y,z) vertex.
|
static |