#include <hps.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (ExportOptionsKit const &in_kit) const |
ExportOptionsKit () | |
ExportOptionsKit (ExportOptionsKit const &in_kit) | |
ExportOptionsKit (ExportOptionsKit &&in_that) | |
HPS::Type | ObjectType () const |
bool | operator!= (ExportOptionsKit const &in_kit) const |
ExportOptionsKit & | operator= (ExportOptionsKit &&in_that) |
ExportOptionsKit & | operator= (ExportOptionsKit const &in_kit) |
bool | operator== (ExportOptionsKit const &in_kit) const |
void | Set (ExportOptionsKit const &in_kit) |
ExportOptionsKit & | SetColorCompression (bool in_state, unsigned int in_bits_per_color=24) |
ExportOptionsKit & | SetConnectivityCompression (bool in_state) |
ExportOptionsKit & | SetEventHandler (HPS::Stream::ExportEventHandler &in_handler, intptr_t in_type) |
ExportOptionsKit & | SetImageCompression (bool in_state, float in_quality=0.75f) |
ExportOptionsKit & | SetIndexCompression (bool in_state, unsigned int in_bits_per_index=8) |
ExportOptionsKit & | SetNormalCompression (bool in_state, unsigned int in_bits_per_normal=10) |
ExportOptionsKit & | SetParameterCompression (bool in_state, unsigned int in_bits_per_parameter=8) |
ExportOptionsKit & | SetSerializeTristrips (bool in_state) |
ExportOptionsKit & | SetToolkit (Toolkit const &in_toolkit) |
ExportOptionsKit & | SetVertexCompression (bool in_state, unsigned int in_bits_per_vertex=24) |
void | Show (ExportOptionsKit &out_kit) const |
bool | ShowColorCompression (bool &out_state, unsigned int &out_bits_per_color) const |
bool | ShowConnectivityCompression (bool &out_state) const |
bool | ShowImageCompression (bool &out_state, float &out_quality) const |
bool | ShowIndexCompression (bool &out_state, unsigned int &out_bits_per_index) const |
bool | ShowNormalCompression (bool &out_state, unsigned int &out_bits_per_normal) const |
bool | ShowParameterCompression (bool &out_state, unsigned int &out_bits_per_parameter) const |
bool | ShowSerializeTristrips (bool &out_state) const |
bool | ShowToolkit (HPS::Stream::Toolkit &out_toolkit) const |
bool | ShowVertexCompression (bool &out_state, unsigned int &out_bits_per_vertex) const |
ExportOptionsKit & | UnsetColorCompression () |
ExportOptionsKit & | UnsetConnectivityCompression () |
ExportOptionsKit & | UnsetEventHandler (intptr_t in_type) |
ExportOptionsKit & | UnsetEventHandlers () |
ExportOptionsKit & | UnsetEverything () |
ExportOptionsKit & | UnsetImageCompression () |
ExportOptionsKit & | UnsetIndexCompression () |
ExportOptionsKit & | UnsetNormalCompression () |
ExportOptionsKit & | UnsetParameterCompression () |
ExportOptionsKit & | UnsetSerializeTristrips () |
ExportOptionsKit & | UnsetToolkit () |
ExportOptionsKit & | UnsetVertexCompression () |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
HPS::Type | Type () const |
Static Public Member Functions | |
static ExportOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
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.
Constructor & Destructor Documentation
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.
- Parameters
-
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.
- Parameters
-
in_that An rvalue reference to an ExportOptionsKit to take the impl from.
Member Function Documentation
|
virtual |
Indicates whether this ExportOptionsKit has any values set on it.
- Returns
- true if no values are set on this ExportOptionsKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::Stream::ExportOptionsKit::Equals | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to compare to this ExportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
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.
- Returns
- A ExportOptionsKit with the default settings.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Object.
bool HPS::Stream::ExportOptionsKit::operator!= | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is not equivalent to this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to compare to this ExportOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
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.
- Parameters
-
in_that An rvalue reference to an ExportOptionsKit to take the impl from.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::operator= | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
- Returns
- A reference to this ExportOptionsKit.
bool HPS::Stream::ExportOptionsKit::operator== | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to compare to this ExportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::Stream::ExportOptionsKit::Set | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
- Parameters
-
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.
- Parameters
-
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.
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
ExportOptionsKit& HPS::Stream::ExportOptionsKit::SetConnectivityCompression | ( | bool | in_state | ) |
Sets connectivity (face list) compression state. Defaults to no compression.
- Parameters
-
in_state Whether color index compression is enabled or not.
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
ExportOptionsKit& HPS::Stream::ExportOptionsKit::SetEventHandler | ( | HPS::Stream::ExportEventHandler & | in_handler, |
intptr_t | in_type | ||
) |
Sets the specified ExportEventHandler for the indicated ExportEvent type.
- Parameters
-
in_handler An ExportEventHandler to be set. in_type The type of the Stream ExportEvent for which the given event handler will be used.
- Returns
- A reference to this ExportOptionsKit.
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.
- Parameters
-
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.
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
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.
- Parameters
-
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.
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
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.
- Parameters
-
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.
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
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.
- Parameters
-
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.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::SetSerializeTristrips | ( | bool | in_state | ) |
Sets tristrips serialization state. Defaults to tristrips are serialized.
- Parameters
-
in_state Whether tristrips serialization is enabled or not.
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
ExportOptionsKit& HPS::Stream::ExportOptionsKit::SetToolkit | ( | Toolkit const & | in_toolkit | ) |
Sets the toolkit used for the export process. If no tooklkit is specified, a default tookit will be used during export. !
- Returns
- A reference to this ExportOptionsKit.
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.
- Parameters
-
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.
- Returns
- A reference to this ExportOptionsKit.
- See also
- Default value
void HPS::Stream::ExportOptionsKit::Show | ( | ExportOptionsKit & | out_kit | ) | const |
Copies this ExportOptionsKit into the given ExportOptionsKit.
- Parameters
-
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.
- Parameters
-
out_state Whether color compression is enabled or not. out_bits_per_color Number of bits to use per color when performing color compression.
- Returns
- true if a color compression setting was specified, false otherwise.
bool HPS::Stream::ExportOptionsKit::ShowConnectivityCompression | ( | bool & | out_state | ) | const |
Shows connectivity (face list) compression state.
- Parameters
-
out_state Whether connectivity compression is enabled or not.
- Returns
- true if a connectivity compression setting was specified, false otherwise.
bool HPS::Stream::ExportOptionsKit::ShowImageCompression | ( | bool & | out_state, |
float & | out_quality | ||
) | const |
Shows image compression state for uncompressed images in segment tree.
- Parameters
-
out_state Whether image compression is enabled or not. out_quality Float in the range [0,1] indicating the quality of the JPEG image.
- Returns
- true if an image compression setting was specified, false otherwise.
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.
- Parameters
-
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.
- Returns
- true if a color index compression setting was specified, false otherwise.
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.
- Parameters
-
out_state Whether normal compression is enabled or not. out_bits_per_normal Number of bits to use per normal when performing normal compression.
- Returns
- true if a normal compression setting was specified, false otherwise.
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.
- Parameters
-
out_state Whether parameter compression is enabled or not. out_bits_per_parameter Number of bits to use per parameter when performing parameter compression.
- Returns
- true if a parameter compression setting was specified, false otherwise.
bool HPS::Stream::ExportOptionsKit::ShowSerializeTristrips | ( | bool & | out_state | ) | const |
Shows tristrips serialization state.
- Parameters
-
out_state Whether tristrips serialization is enabled or not.
- Returns
- true if a tristrips serialization setting was specified, false otherwise.
bool HPS::Stream::ExportOptionsKit::ShowToolkit | ( | HPS::Stream::Toolkit & | out_toolkit | ) | const |
Shows the root toolkit used for the export process.
- Parameters
-
out_toolkit The Toolkit used for the export process.
- Returns
- true if a toolkit was specified, false otherwise.
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.
- Parameters
-
out_state Whether vertex compression is enabled or not. out_bits_per_vertex Number of bits to use per vertex when performing vertex compression.
- Returns
- true if a vertex compression setting was specified, false otherwise.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetColorCompression | ( | ) |
Removes color compression state and maximum number of bits to use for each (r,g,b) color.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetConnectivityCompression | ( | ) |
Removes connectivity (face list) compression state.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetEventHandler | ( | intptr_t | in_type | ) |
Unsets the ExportEventHandler for the indicated ExportEvent type.
- Parameters
-
in_type The type of the Stream ExportEvent to unset.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetEventHandlers | ( | ) |
Unsets the ExportEventHandler for all ExportEvent types.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportOptionsKit.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetImageCompression | ( | ) |
Removes image compression state for uncompressed images in segment tree.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetIndexCompression | ( | ) |
Removes color index compression state and maximum number of bits to use for each float index.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetNormalCompression | ( | ) |
Removes normal compression state and maximum number of bits to use for each (x,y,z) normal.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetParameterCompression | ( | ) |
Removes vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetSerializeTristrips | ( | ) |
Removes tristrips serialization state.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetToolkit | ( | ) |
Removes the toolkit used for the export process. !
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetVertexCompression | ( | ) |
Removes vertex compression state and maximum number of bits to use for each (x,y,z) vertex.
- Returns
- A reference to this ExportOptionsKit.
The documentation for this class was generated from the following file:
- include/hps.h