
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 () |
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. Defaults to no compression. 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. Defaults to no compression. More... | |
HPS.Stream.ExportOptionsKit | SetConnectivityCompression (bool in_state) |
Sets connectivity (face list) compression state. Defaults to no compression. More... | |
HPS.Stream.ExportOptionsKit | SetDefaultCamera (HPS.CameraKit in_camera) |
Sets the default camera used for the export process. If no camera is specified, no default camera will be used during export. More... | |
HPS.Stream.ExportOptionsKit | SetEventHandler (HPS.Stream.ExportEventHandler in_handler, IntPtr in_type) |
Sets the specified ExportEventHandler for the indicated ExportEvent type. More... | |
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. More... | |
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. 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. Defaults to no compression. More... | |
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. 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. Defaults to no compression. 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. Defaults to no compression. 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. Defaults to no compression. 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. Defaults to no compression. More... | |
HPS.Stream.ExportOptionsKit | SetSerializeTristrips (bool in_state) |
Sets tristrips serialization state. Defaults to tristrips are serialized. More... | |
HPS.Stream.ExportOptionsKit | SetToolkit (HPS.Stream.Toolkit in_toolkit) |
Sets the toolkit used for the export process. If no toolkit is specified, a default tookit will be used during export. 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. Defaults to no compression. 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. Defaults to no compression. 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 | ShowDefaultCamera (out HPS.CameraKit out_camera) |
Shows the default camera used for the export process. 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 | ShowSerializeTristrips (out bool out_state) |
Shows tristrips serialization state. More... | |
bool | ShowToolkit (out HPS.Stream.Toolkit out_toolkit) |
Shows the root toolkit used for the export process. 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 | UnsetDefaultCamera () |
Removes the default camera used for the export process. More... | |
HPS.Stream.ExportOptionsKit | UnsetEventHandler (IntPtr in_type) |
Unsets the ExportEventHandler for the indicated ExportEvent type. More... | |
HPS.Stream.ExportOptionsKit | UnsetEventHandlers () |
Unsets the ExportEventHandler for all ExportEvent types. 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 | UnsetSerializeTristrips () |
Removes tristrips serialization state. More... | |
HPS.Stream.ExportOptionsKit | UnsetToolkit () |
Removes the toolkit used for the export process. More... | |
HPS.Stream.ExportOptionsKit | UnsetVertexCompression () |
Removes vertex compression state and maximum number of bits to use for each (x,y,z) vertex. More... | |
![]() | |
Kit (HPS.Kit in_that) | |
override HPS.Type | Type () |
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. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static HPS.Stream.ExportOptionsKit | 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. 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 |
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
|
inline |
The default constructor creates an empty ExportOptionsKit object.
|
inline |
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.
Member Function Documentation
|
inlinevirtual |
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.
|
inline |
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.
|
inlinestatic |
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.
|
inline |
Copies the source ExportOptionsKit into this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
|
inline |
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.
Default value
|
inline |
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.
- Returns
- A reference to this ExportOptionsKit.
Default value
|
inline |
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.
Default value
|
inline |
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.
|
inline |
Sets the specified ExportEventHandler for the indicated ExportEvent type.
- Parameters
-
in_handler An ExportEventHandler to be set. in_type The type of the StreamExportEvent for which the given event handler will be used.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
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.
Default value
|
inline |
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.
- Returns
- A reference to this ExportOptionsKit.
Default value
|
inline |
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.
Default value
|
inline |
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.
- Returns
- A reference to this ExportOptionsKit.
Default value
|
inline |
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.
Default value
|
inline |
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.
- Returns
- A reference to this ExportOptionsKit.
Default value
|
inline |
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.
|
inline |
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.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
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.
Default value
|
inline |
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.
|
inline |
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.
Default value
|
inline |
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.
- Returns
- A reference to this ExportOptionsKit.
Default value
|
inline |
Copies this ExportOptionsKit into the given ExportOptionsKit.
- Parameters
-
out_kit The ExportOptionsKit to populate with the contents of this ExportOptionsKit.
|
inline |
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.
|
inline |
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.
|
inline |
Shows the default camera used for the export process.
- Parameters
-
out_camera The camera being used as default.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
Removes color compression state and maximum number of bits to use for each (r,g,b) color.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Removes connectivity (face list) compression state.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Removes the default camera used for the export process.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Unsets the ExportEventHandler for the indicated ExportEvent type.
- Parameters
-
in_type The type of the StreamExportEvent to unset.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Unsets the ExportEventHandler for all ExportEvent types.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Removes all settings from this ExportOptionsKit.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Removes image compression state for uncompressed images in segment tree.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Removes color index compression state and maximum number of bits to use for each float index.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Removes normal compression state and maximum number of bits to use for each (x,y,z) normal.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Removes vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Removes tristrips serialization state.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Removes the toolkit used for the export process.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
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:
- internals/hps_core/source/cs/HPS.Stream.cs