REFERENCE MANUAL
The Stream::ExportOptionsKit class contains settings controlling the export of HSF files. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ExportOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Stream.ExportOptionsKit in_kit) |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More... | |
ExportOptionsKit () | |
The default constructor creates an empty ExportOptionsKit object. More... | |
ExportOptionsKit (HPS.Stream.ExportOptionsKit in_kit) | |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.Stream.ExportOptionsKit in_kit) |
Copies the source ExportOptionsKit into this ExportOptionsKit. More... | |
HPS.Stream.ExportOptionsKit | SetColorCompression (bool in_state, uint in_bits_per_color) |
Sets color compression state and maximum number of bits to use for each (r,g,b) color. More... | |
HPS.Stream.ExportOptionsKit | SetColorCompression (bool in_state) |
Sets color compression state and maximum number of bits to use for each (r,g,b) color. More... | |
HPS.Stream.ExportOptionsKit | SetConnectivityCompression (bool in_state) |
Sets connectivity (face list) compression state. More... | |
HPS.Stream.ExportOptionsKit | SetImageCompression (bool in_state, float in_quality) |
Sets image compression state for uncompressed images in segment tree. More... | |
HPS.Stream.ExportOptionsKit | SetImageCompression (bool in_state) |
Sets image compression state for uncompressed images in segment tree. More... | |
HPS.Stream.ExportOptionsKit | SetIndexCompression (bool in_state, uint in_bits_per_index) |
Sets color index compression state and maximum number of bits to use for each float index. More... | |
HPS.Stream.ExportOptionsKit | SetIndexCompression (bool in_state) |
Sets color index compression state and maximum number of bits to use for each float index. More... | |
HPS.Stream.ExportOptionsKit | SetNormalCompression (bool in_state, uint in_bits_per_normal) |
Sets normal compression state and maximum number of bits to use for each (x,y,z) normal. More... | |
HPS.Stream.ExportOptionsKit | SetNormalCompression (bool in_state) |
Sets normal compression state and maximum number of bits to use for each (x,y,z) normal. More... | |
HPS.Stream.ExportOptionsKit | SetParameterCompression (bool in_state, uint in_bits_per_parameter) |
Sets vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter. More... | |
HPS.Stream.ExportOptionsKit | SetParameterCompression (bool in_state) |
Sets vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter. More... | |
HPS.Stream.ExportOptionsKit | SetVertexCompression (bool in_state, uint in_bits_per_vertex) |
Sets vertex compression state and maximum number of bits to use for each (x,y,z) vertex. More... | |
HPS.Stream.ExportOptionsKit | SetVertexCompression (bool in_state) |
Sets vertex compression state and maximum number of bits to use for each (x,y,z) vertex. More... | |
void | Show (out HPS.Stream.ExportOptionsKit out_kit) |
Copies this ExportOptionsKit into the given ExportOptionsKit. More... | |
bool | ShowColorCompression (out bool out_state, out uint out_bits_per_color) |
Shows color compression state and maximum number of bits to use for each (r,g,b) color. More... | |
bool | ShowConnectivityCompression (out bool out_state) |
Shows connectivity (face list) compression state. More... | |
bool | ShowImageCompression (out bool out_state, out float out_quality) |
Shows image compression state for uncompressed images in segment tree. More... | |
bool | ShowIndexCompression (out bool out_state, out uint out_bits_per_index) |
Shows color index compression state and maximum number of bits to use for each float index. More... | |
bool | ShowNormalCompression (out bool out_state, out uint out_bits_per_normal) |
Shows normal compression state and maximum number of bits to use for each (x,y,z) normal. More... | |
bool | ShowParameterCompression (out bool out_state, out uint out_bits_per_parameter) |
Shows vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter. More... | |
bool | ShowVertexCompression (out bool out_state, out uint out_bits_per_vertex) |
Shows vertex compression state and maximum number of bits to use for each (x,y,z) vertex. More... | |
HPS.Stream.ExportOptionsKit | UnsetColorCompression () |
Removes color compression state and maximum number of bits to use for each (r,g,b) color. More... | |
HPS.Stream.ExportOptionsKit | UnsetConnectivityCompression () |
Removes connectivity (face list) compression state. More... | |
HPS.Stream.ExportOptionsKit | UnsetEverything () |
Removes all settings from this ExportOptionsKit. More... | |
HPS.Stream.ExportOptionsKit | UnsetImageCompression () |
Removes image compression state for uncompressed images in segment tree. More... | |
HPS.Stream.ExportOptionsKit | UnsetIndexCompression () |
Removes color index compression state and maximum number of bits to use for each float index. More... | |
HPS.Stream.ExportOptionsKit | UnsetNormalCompression () |
Removes normal compression state and maximum number of bits to use for each (x,y,z) normal. More... | |
HPS.Stream.ExportOptionsKit | UnsetParameterCompression () |
Removes vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter. More... | |
HPS.Stream.ExportOptionsKit | UnsetVertexCompression () |
Removes vertex compression state and maximum number of bits to use for each (x,y,z) vertex. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static HPS.Stream.ExportOptionsKit | GetDefault () |
Creates a ExportOptionsKit which contains the default settings. More... | |
static bool | operator!= (HPS.Stream.ExportOptionsKit a, HPS.Stream.ExportOptionsKit b) |
static bool | operator== (HPS.Stream.ExportOptionsKit a, HPS.Stream.ExportOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The Stream::ExportOptionsKit class contains settings controlling the export of HSF files.
Calling 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 | ( | HPS.Stream.ExportOptionsKit | in_kit | ) |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_stream_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to copy. |
|
virtual |
Indicates whether this ExportOptionsKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.Stream.ExportOptionsKit.Equals | ( | HPS.Stream.ExportOptionsKit | in_kit | ) |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_stream_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_stream_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref>. |
|
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.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.Stream.ExportOptionsKit.Set | ( | HPS.Stream.ExportOptionsKit | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_stream_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to copy. |
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetColorCompression | ( | bool | in_state, |
uint | in_bits_per_color | ||
) |
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. |
Default value
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetColorCompression | ( | bool | in_state | ) |
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. |
Default value
HPS.Stream.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. |
Default value
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetImageCompression | ( | bool | in_state, |
float | in_quality | ||
) |
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 | <ref refid="class_h_p_s_1_1_float" kindref="compound">Float</ref> in the range [0,1] indicating the quality of the JPEG image. Defaults to 0.75f. |
Default value
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetImageCompression | ( | bool | in_state | ) |
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. |
Default value
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetIndexCompression | ( | bool | in_state, |
uint | in_bits_per_index | ||
) |
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. |
Default value
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetIndexCompression | ( | bool | in_state | ) |
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. |
Default value
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetNormalCompression | ( | bool | in_state, |
uint | in_bits_per_normal | ||
) |
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. |
Default value
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetNormalCompression | ( | bool | in_state | ) |
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. |
Default value
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetParameterCompression | ( | bool | in_state, |
uint | in_bits_per_parameter | ||
) |
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. |
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetParameterCompression | ( | bool | in_state | ) |
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. |
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetVertexCompression | ( | bool | in_state, |
uint | in_bits_per_vertex | ||
) |
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. |
Default value
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetVertexCompression | ( | bool | in_state | ) |
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. |
Default value
void HPS.Stream.ExportOptionsKit.Show | ( | out HPS.Stream.ExportOptionsKit | out_kit | ) |
Copies this ExportOptionsKit into the given ExportOptionsKit.
out_kit | The <ref refid="class_h_p_s_1_1_stream_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_stream_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref>. |
bool HPS.Stream.ExportOptionsKit.ShowColorCompression | ( | out bool | out_state, |
out uint | out_bits_per_color | ||
) |
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 | ( | out bool | out_state | ) |
Shows connectivity (face list) compression state.
out_state | Whether connectivity compression is enabled or not. |
bool HPS.Stream.ExportOptionsKit.ShowImageCompression | ( | out bool | out_state, |
out float | out_quality | ||
) |
Shows image compression state for uncompressed images in segment tree.
out_state | Whether image compression is enabled or not. |
out_quality | <ref refid="class_h_p_s_1_1_float" kindref="compound">Float</ref> in the range [0,1] indicating the quality of the JPEG image. |
bool HPS.Stream.ExportOptionsKit.ShowIndexCompression | ( | out bool | out_state, |
out uint | out_bits_per_index | ||
) |
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. |
bool HPS.Stream.ExportOptionsKit.ShowNormalCompression | ( | out bool | out_state, |
out uint | out_bits_per_normal | ||
) |
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 | ( | out bool | out_state, |
out uint | out_bits_per_parameter | ||
) |
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.ShowVertexCompression | ( | out bool | out_state, |
out uint | out_bits_per_vertex | ||
) |
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. |
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetColorCompression | ( | ) |
Removes color compression state and maximum number of bits to use for each (r,g,b) color.
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetConnectivityCompression | ( | ) |
Removes connectivity (face list) compression state.
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetEverything | ( | ) |
Removes all settings from this ExportOptionsKit.
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetImageCompression | ( | ) |
Removes image compression state for uncompressed images in segment tree.
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetIndexCompression | ( | ) |
Removes color index compression state and maximum number of bits to use for each float index.
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetNormalCompression | ( | ) |
Removes normal compression state and maximum number of bits to use for each (x,y,z) normal.
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetParameterCompression | ( | ) |
Removes vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter.
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetVertexCompression | ( | ) |
Removes vertex compression state and maximum number of bits to use for each (x,y,z) vertex.