HPS.Stream.ExportOptionsKit

class HPS.Stream.ExportOptionsKit : public HPS.Kit 

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.

Public Functions

override bool Empty ()

Indicates whether this ExportOptionsKit has any values set on it.

Return: true if no values are set on this ExportOptionsKit, false otherwise.

bool Equals (HPS.Stream.ExportOptionsKit in_kit)

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Param in_kit: The source ExportOptionsKit to compare to this ExportOptionsKit.
Return: true if the objects are equivalent, false otherwise.

ExportOptionsKit (): The default constructor creates an empty ExportOptionsKit object.

ExportOptionsKit (HPS.Stream.ExportOptionsKit in_kit)

The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit.

Param in_kit: The source ExportOptionsKit to copy.

override HPS.Type ObjectType ()

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).

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Stream.ExportOptionsKit in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Param in_kit: The source ExportOptionsKit to copy.

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.

See: Default value

Param in_state: Whether color compression is enabled or not.
Return: A reference to this 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.

See: Default value

Param in_state: Whether color compression is enabled or not.
Param 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.
Return: A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetConnectivityCompression (bool in_state)

Sets connectivity (face list) compression state. Defaults to no compression.

See: Default value

Param in_state: Whether color index compression is enabled or not.
Return: A reference to this ExportOptionsKit.

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.

Param in_camera: The camera to apply as default.
Return: A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetEventHandler (HPS.Stream.ExportEventHandler in_handler, IntPtr in_type)

Sets the specified ExportEventHandler for the indicated ExportEvent type.

Param in_handler: An ExportEventHandler to be set.
Param in_type: The type of the StreamExportEvent for which the given event handler will be used.
Return: A reference to this 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.

See: Default value

Param 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.
Return: A reference to this 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.

See: Default value

Param 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.
Param in_quality: Float in the range [0,1] indicating the quality of the JPEG image. Defaults to 0.75f.
Return: A reference to this 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.

See: Default value

Param in_state: Whether color index compression is enabled or not.
Return: A reference to this 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.

See: Default value

Param in_state: Whether color index compression is enabled or not.
Param 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.
Return: A reference to this 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.

See: Default value

Param in_state: Whether normal compression is enabled or not.
Return: A reference to this 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.

See: Default value

Param in_state: Whether normal compression is enabled or not.
Param 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.
Return: A reference to this 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.

Param in_state: Whether parameter compression is enabled or not.
Return: A reference to this 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.

Param in_state: Whether parameter compression is enabled or not.
Param 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.
Return: A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetSerializeTristrips (bool in_state)

Sets tristrips serialization state. Defaults to tristrips are serialized.

See: Default value

Param in_state: Whether tristrips serialization is enabled or not.
Return: A reference to this ExportOptionsKit.

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.

Return: A reference to this 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.

See: Default value

Param in_state: Whether vertex compression is enabled or not.
Return: A reference to this 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.

See: Default value

Param in_state: Whether vertex compression is enabled or not.
Param 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.
Return: A reference to this ExportOptionsKit.

void Show (out HPS.Stream.ExportOptionsKit out_kit)

Copies this ExportOptionsKit into the given ExportOptionsKit.

Param out_kit: The ExportOptionsKit to populate with the contents of this ExportOptionsKit.

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.

Param out_state: Whether color compression is enabled or not.
Param out_bits_per_color: Number of bits to use per color when performing color compression.
Return: true if a color compression setting was specified, false otherwise.

bool ShowConnectivityCompression (out bool out_state)

Shows connectivity (face list) compression state.

Param out_state: Whether connectivity compression is enabled or not.
Return: true if a connectivity compression setting was specified, false otherwise.

bool ShowDefaultCamera (out HPS.CameraKit out_camera)

Shows the default camera used for the export process.

Param out_camera: The camera being used as default.
Return: A reference to this ExportOptionsKit.

bool ShowImageCompression (out bool out_state, out float out_quality)

Shows image compression state for uncompressed images in segment tree.

Param out_state: Whether image compression is enabled or not.
Param out_quality: Float in the range [0,1] indicating the quality of the JPEG image.
Return: true if an image compression setting was specified, false otherwise.

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.

Param out_state: Whether color index compression is enabled or not.
Param out_bits_per_index: Number of bits to use per index when performing color index compression.
Return: true if a color index compression setting was specified, false otherwise.

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.

Param out_state: Whether normal compression is enabled or not.
Param out_bits_per_normal: Number of bits to use per normal when performing normal compression.
Return: true if a normal compression setting was specified, false otherwise.

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.

Param out_state: Whether parameter compression is enabled or not.
Param out_bits_per_parameter: Number of bits to use per parameter when performing parameter compression.
Return: true if a parameter compression setting was specified, false otherwise.

bool ShowSerializeTristrips (out bool out_state)

Shows tristrips serialization state.

Param out_state: Whether tristrips serialization is enabled or not.
Return: true if a tristrips serialization setting was specified, false otherwise.

bool ShowToolkit (out HPS.Stream.Toolkit out_toolkit)

Shows the root toolkit used for the export process.

Param out_toolkit: The Toolkit used for the export process.
Return: true if a toolkit was specified, false otherwise.

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.

Param out_state: Whether vertex compression is enabled or not.
Param out_bits_per_vertex: Number of bits to use per vertex when performing vertex compression.
Return: true if a vertex compression setting was specified, false otherwise.

HPS.Stream.ExportOptionsKit UnsetColorCompression ()

Removes color compression state and maximum number of bits to use for each (r,g,b) color.

Return: A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetConnectivityCompression ()

Removes connectivity (face list) compression state.

Return: A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetDefaultCamera ()

Removes the default camera used for the export process.

Return: A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetEventHandler (IntPtr in_type)

Unsets the ExportEventHandler for the indicated ExportEvent type.

Param in_type: The type of the StreamExportEvent to unset.
Return: A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetEventHandlers ()

Unsets the ExportEventHandler for all ExportEvent types.

Return: A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetEverything ()

Removes all settings from this ExportOptionsKit.

Return: A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetImageCompression ()

Removes image compression state for uncompressed images in segment tree.

Return: A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetIndexCompression ()

Removes color index compression state and maximum number of bits to use for each float index.

Return: A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetNormalCompression ()

Removes normal compression state and maximum number of bits to use for each (x,y,z) normal.

Return: A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetParameterCompression ()

Removes vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter.

Return: A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetSerializeTristrips ()

Removes tristrips serialization state.

Return: A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetToolkit ()

Removes the toolkit used for the export process.

Return: A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetVertexCompression ()

Removes vertex compression state and maximum number of bits to use for each (x,y,z) vertex.

Return: A reference to this ExportOptionsKit.

Public Static Functions

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.

Return: A ExportOptionsKit with the default settings.