< Home

< Table of Contents

REFERENCE MANUAL

HPS.Stream.ExportOptionsKit Class Reference

The Stream::ExportOptionsKit class contains settings controlling the export of HSF files. More...

Inheritance diagram for HPS.Stream.ExportOptionsKit:
HPS.Object

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...
 
- Public Member Functions inherited from HPS.Object
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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

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.

Constructor & Destructor Documentation

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.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_stream_1_1_export_options_kit" kindref="compound">ExportOptionsKit</ref> to copy.

Member Function Documentation

override bool HPS.Stream.ExportOptionsKit.Empty ( )
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 ( HPS.Stream.ExportOptionsKit  in_kit)

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters
in_kitThe 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>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.GetDefault ( )
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.
override HPS.Type HPS.Stream.ExportOptionsKit.ObjectType ( )
virtual

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.

void HPS.Stream.ExportOptionsKit.Set ( HPS.Stream.ExportOptionsKit  in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters
in_kitThe 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.

Parameters
in_stateWhether color compression is enabled or not.
in_bits_per_colorNumber 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

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.

Parameters
in_stateWhether color compression is enabled or not.
Returns
A reference to this ExportOptionsKit.

Default value

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetConnectivityCompression ( bool  in_state)

Sets connectivity (face list) compression state.

Defaults to no compression.

Parameters
in_stateWhether color index compression is enabled or not.
Returns
A reference to this ExportOptionsKit.

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.

Parameters
in_stateWhether 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.
Returns
A reference to this ExportOptionsKit.

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.

Parameters
in_stateWhether 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

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.

Parameters
in_stateWhether color index compression is enabled or not.
in_bits_per_indexNumber 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

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.

Parameters
in_stateWhether color index compression is enabled or not.
Returns
A reference to this ExportOptionsKit.

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.

Parameters
in_stateWhether normal compression is enabled or not.
in_bits_per_normalNumber 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

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.

Parameters
in_stateWhether normal compression is enabled or not.
Returns
A reference to this ExportOptionsKit.

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.

Parameters
in_stateWhether parameter compression is enabled or not.
in_bits_per_parameterNumber 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.
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.

Parameters
in_stateWhether parameter compression is enabled or not.
Returns
A reference to this ExportOptionsKit.
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.

Parameters
in_stateWhether vertex compression is enabled or not.
in_bits_per_vertexNumber 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

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.

Parameters
in_stateWhether vertex compression is enabled or not.
Returns
A reference to this ExportOptionsKit.

Default value

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

Copies this ExportOptionsKit into the given ExportOptionsKit.

Parameters
out_kitThe <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.

Parameters
out_stateWhether color compression is enabled or not.
out_bits_per_colorNumber 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 ( out bool  out_state)

Shows connectivity (face list) compression state.

Parameters
out_stateWhether connectivity compression is enabled or not.
Returns
true if a connectivity compression setting was specified, false otherwise.
bool HPS.Stream.ExportOptionsKit.ShowImageCompression ( out bool  out_state,
out float  out_quality 
)

Shows image compression state for uncompressed images in segment tree.

Parameters
out_stateWhether 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.
Returns
true if an image compression setting was specified, false otherwise.
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.

Parameters
out_stateWhether color index compression is enabled or not.
Returns
true if a color index compression setting was specified, false otherwise.
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.

Parameters
out_stateWhether normal compression is enabled or not.
out_bits_per_normalNumber 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 ( 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.

Parameters
out_stateWhether parameter compression is enabled or not.
out_bits_per_parameterNumber 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.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.

Parameters
out_stateWhether vertex compression is enabled or not.
out_bits_per_vertexNumber of bits to use per vertex when performing vertex compression.
Returns
true if a vertex compression setting was specified, false otherwise.
HPS.Stream.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.
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetConnectivityCompression ( )

Removes connectivity (face list) compression state.

Returns
A reference to this ExportOptionsKit.
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetEverything ( )

Removes all settings from this ExportOptionsKit.

Returns
A reference to this ExportOptionsKit.
HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetImageCompression ( )

Removes image compression state for uncompressed images in segment tree.

Returns
A reference to this ExportOptionsKit.
HPS.Stream.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.
HPS.Stream.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.
HPS.Stream.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.
HPS.Stream.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: