#include <hps.h>
|
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 & | SetDefaultCamera (CameraKit const &in_camera) |
|
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 | ShowDefaultCamera (CameraKit &out_camera) 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 & | UnsetDefaultCamera () |
|
ExportOptionsKit & | UnsetEventHandler (intptr_t in_type) |
|
ExportOptionsKit & | UnsetEventHandlers () |
|
ExportOptionsKit & | UnsetEverything () |
|
ExportOptionsKit & | UnsetImageCompression () |
|
ExportOptionsKit & | UnsetIndexCompression () |
|
ExportOptionsKit & | UnsetNormalCompression () |
|
ExportOptionsKit & | UnsetParameterCompression () |
|
ExportOptionsKit & | UnsetSerializeTristrips () |
|
ExportOptionsKit & | UnsetToolkit () |
|
ExportOptionsKit & | UnsetVertexCompression () |
|
virtual HPS::Type | Type () const |
|
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 () |
|
|
static const HPS::Type | staticType = HPS::Type::StreamExportOptionsKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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.
◆ ExportOptionsKit() [1/3]
HPS::Stream::ExportOptionsKit::ExportOptionsKit |
( |
| ) |
|
◆ ExportOptionsKit() [2/3]
HPS::Stream::ExportOptionsKit::ExportOptionsKit |
( |
ExportOptionsKit const & |
in_kit | ) |
|
◆ ExportOptionsKit() [3/3]
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
-
◆ Empty()
bool HPS::Stream::ExportOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
◆ Equals()
bool HPS::Stream::ExportOptionsKit::Equals |
( |
ExportOptionsKit const & |
in_kit | ) |
const |
◆ GetDefault()
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.
◆ ObjectType()
HPS::Type HPS::Stream::ExportOptionsKit::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::Kit.
◆ operator!=()
bool HPS::Stream::ExportOptionsKit::operator!= |
( |
ExportOptionsKit const & |
in_kit | ) |
const |
◆ operator=() [1/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this ExportOptionsKit.
◆ operator=() [2/2]
◆ operator==()
bool HPS::Stream::ExportOptionsKit::operator== |
( |
ExportOptionsKit const & |
in_kit | ) |
const |
◆ Set()
◆ SetColorCompression()
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
◆ SetConnectivityCompression()
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
◆ SetDefaultCamera()
Sets the default camera used for the export process. If no camera is specified, no default camera will be used during export.
- Parameters
-
in_camera | The camera to apply as default. |
- Returns
- A reference to this ExportOptionsKit.
◆ SetEventHandler()
◆ SetImageCompression()
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
◆ SetIndexCompression()
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
◆ SetNormalCompression()
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
◆ SetParameterCompression()
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.
◆ SetSerializeTristrips()
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
◆ SetToolkit()
Sets the toolkit used for the export process. If no toolkit is specified, a default tookit will be used during export.
- Returns
- A reference to this ExportOptionsKit.
◆ SetVertexCompression()
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
◆ Show()
◆ ShowColorCompression()
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.
◆ ShowConnectivityCompression()
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.
◆ ShowDefaultCamera()
bool HPS::Stream::ExportOptionsKit::ShowDefaultCamera |
( |
CameraKit & |
out_camera | ) |
const |
Shows the default camera used for the export process.
- Parameters
-
out_camera | The camera being used as default. |
- Returns
- A reference to this ExportOptionsKit.
◆ ShowImageCompression()
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.
◆ ShowIndexCompression()
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.
◆ ShowNormalCompression()
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.
◆ ShowParameterCompression()
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.
◆ ShowSerializeTristrips()
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.
◆ ShowToolkit()
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.
◆ ShowVertexCompression()
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.
◆ UnsetColorCompression()
Removes color compression state and maximum number of bits to use for each (r,g,b) color.
- Returns
- A reference to this ExportOptionsKit.
◆ UnsetConnectivityCompression()
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetConnectivityCompression |
( |
| ) |
|
Removes connectivity (face list) compression state.
- Returns
- A reference to this ExportOptionsKit.
◆ UnsetDefaultCamera()
Removes the default camera used for the export process.
- Returns
- A reference to this ExportOptionsKit.
◆ UnsetEventHandler()
ExportOptionsKit& HPS::Stream::ExportOptionsKit::UnsetEventHandler |
( |
intptr_t |
in_type | ) |
|
◆ UnsetEventHandlers()
◆ UnsetEverything()
◆ UnsetImageCompression()
Removes image compression state for uncompressed images in segment tree.
- Returns
- A reference to this ExportOptionsKit.
◆ UnsetIndexCompression()
Removes color index compression state and maximum number of bits to use for each float index.
- Returns
- A reference to this 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.
◆ UnsetParameterCompression()
Removes vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter.
- Returns
- A reference to this ExportOptionsKit.
◆ UnsetSerializeTristrips()
Removes tristrips serialization state.
- Returns
- A reference to this ExportOptionsKit.
◆ UnsetToolkit()
Removes the toolkit used for the export process.
- Returns
- A reference to this 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: