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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Stream.ExportOptionsKit in_kit)
 
 ExportOptionsKit ()
 
 ExportOptionsKit (HPS.Stream.ExportOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Stream.ExportOptionsKit in_kit)
 
HPS.Stream.ExportOptionsKit SetColorCompression (bool in_state, uint in_bits_per_color)
 
HPS.Stream.ExportOptionsKit SetColorCompression (bool in_state)
 
HPS.Stream.ExportOptionsKit SetConnectivityCompression (bool in_state)
 
HPS.Stream.ExportOptionsKit SetDefaultCamera (HPS.CameraKit in_camera)
 
HPS.Stream.ExportOptionsKit SetEventHandler (HPS.Stream.ExportEventHandler in_handler, IntPtr in_type)
 
HPS.Stream.ExportOptionsKit SetImageCompression (bool in_state, float in_quality)
 
HPS.Stream.ExportOptionsKit SetImageCompression (bool in_state)
 
HPS.Stream.ExportOptionsKit SetIndexCompression (bool in_state, uint in_bits_per_index)
 
HPS.Stream.ExportOptionsKit SetIndexCompression (bool in_state)
 
HPS.Stream.ExportOptionsKit SetNormalCompression (bool in_state, uint in_bits_per_normal)
 
HPS.Stream.ExportOptionsKit SetNormalCompression (bool in_state)
 
HPS.Stream.ExportOptionsKit SetParameterCompression (bool in_state, uint in_bits_per_parameter)
 
HPS.Stream.ExportOptionsKit SetParameterCompression (bool in_state)
 
HPS.Stream.ExportOptionsKit SetSerializeTristrips (bool in_state)
 
HPS.Stream.ExportOptionsKit SetToolkit (HPS.Stream.Toolkit in_toolkit)
 
HPS.Stream.ExportOptionsKit SetVertexCompression (bool in_state, uint in_bits_per_vertex)
 
HPS.Stream.ExportOptionsKit SetVertexCompression (bool in_state)
 
void Show (out HPS.Stream.ExportOptionsKit out_kit)
 
bool ShowColorCompression (out bool out_state, out uint out_bits_per_color)
 
bool ShowConnectivityCompression (out bool out_state)
 
bool ShowDefaultCamera (out HPS.CameraKit out_camera)
 
bool ShowImageCompression (out bool out_state, out float out_quality)
 
bool ShowIndexCompression (out bool out_state, out uint out_bits_per_index)
 
bool ShowNormalCompression (out bool out_state, out uint out_bits_per_normal)
 
bool ShowParameterCompression (out bool out_state, out uint out_bits_per_parameter)
 
bool ShowSerializeTristrips (out bool out_state)
 
bool ShowToolkit (out HPS.Stream.Toolkit out_toolkit)
 
bool ShowVertexCompression (out bool out_state, out uint out_bits_per_vertex)
 
HPS.Stream.ExportOptionsKit UnsetColorCompression ()
 
HPS.Stream.ExportOptionsKit UnsetConnectivityCompression ()
 
HPS.Stream.ExportOptionsKit UnsetDefaultCamera ()
 
HPS.Stream.ExportOptionsKit UnsetEventHandler (IntPtr in_type)
 
HPS.Stream.ExportOptionsKit UnsetEventHandlers ()
 
HPS.Stream.ExportOptionsKit UnsetEverything ()
 
HPS.Stream.ExportOptionsKit UnsetImageCompression ()
 
HPS.Stream.ExportOptionsKit UnsetIndexCompression ()
 
HPS.Stream.ExportOptionsKit UnsetNormalCompression ()
 
HPS.Stream.ExportOptionsKit UnsetParameterCompression ()
 
HPS.Stream.ExportOptionsKit UnsetSerializeTristrips ()
 
HPS.Stream.ExportOptionsKit UnsetToolkit ()
 
HPS.Stream.ExportOptionsKit UnsetVertexCompression ()
 
- Public Member Functions inherited from HPS.Kit
Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.Stream.ExportOptionsKit GetDefault ()
 
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
 

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

◆ ExportOptionsKit() [1/2]

HPS.Stream.ExportOptionsKit.ExportOptionsKit ( )
inline

The default constructor creates an empty ExportOptionsKit object.

◆ ExportOptionsKit() [2/2]

HPS.Stream.ExportOptionsKit.ExportOptionsKit ( HPS.Stream.ExportOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ExportOptionsKit to copy.

Member Function Documentation

◆ Empty()

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

◆ Equals()

bool HPS.Stream.ExportOptionsKit.Equals ( HPS.Stream.ExportOptionsKit  in_kit)
inline

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to compare to this ExportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.GetDefault ( )
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.

◆ ObjectType()

override HPS.Type HPS.Stream.ExportOptionsKit.ObjectType ( )
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.

◆ Set()

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

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to copy.

◆ SetColorCompression() [1/2]

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetColorCompression ( bool  in_state,
uint  in_bits_per_color 
)
inline

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.
See also
Default value

◆ SetColorCompression() [2/2]

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetColorCompression ( bool  in_state)
inline

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.
See also
Default value

◆ SetConnectivityCompression()

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

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.
See also
Default value

◆ SetDefaultCamera()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetDefaultCamera ( HPS.CameraKit  in_camera)
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_cameraThe camera to apply as default.
Returns
A reference to this ExportOptionsKit.

◆ SetEventHandler()

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

Sets the specified ExportEventHandler for the indicated ExportEvent type.

Parameters
in_handlerAn ExportEventHandler to be set.
in_typeThe type of the StreamExportEvent for which the given event handler will be used.
Returns
A reference to this ExportOptionsKit.

◆ SetImageCompression() [1/2]

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetImageCompression ( bool  in_state,
float  in_quality 
)
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_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_qualityFloat 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

◆ SetImageCompression() [2/2]

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetImageCompression ( bool  in_state)
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_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.
See also
Default value

◆ SetIndexCompression() [1/2]

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetIndexCompression ( bool  in_state,
uint  in_bits_per_index 
)
inline

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.
See also
Default value

◆ SetIndexCompression() [2/2]

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetIndexCompression ( bool  in_state)
inline

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.
See also
Default value

◆ SetNormalCompression() [1/2]

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetNormalCompression ( bool  in_state,
uint  in_bits_per_normal 
)
inline

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.
See also
Default value

◆ SetNormalCompression() [2/2]

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetNormalCompression ( bool  in_state)
inline

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.
See also
Default value

◆ SetParameterCompression() [1/2]

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetParameterCompression ( bool  in_state,
uint  in_bits_per_parameter 
)
inline

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.

◆ SetParameterCompression() [2/2]

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetParameterCompression ( bool  in_state)
inline

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.

◆ SetSerializeTristrips()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetSerializeTristrips ( bool  in_state)
inline

Sets tristrips serialization state. Defaults to tristrips are serialized.

Parameters
in_stateWhether tristrips serialization is enabled or not.
Returns
A reference to this ExportOptionsKit.
See also
Default value

◆ SetToolkit()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetToolkit ( HPS.Stream.Toolkit  in_toolkit)
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.

◆ SetVertexCompression() [1/2]

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetVertexCompression ( bool  in_state,
uint  in_bits_per_vertex 
)
inline

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.
See also
Default value

◆ SetVertexCompression() [2/2]

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.SetVertexCompression ( bool  in_state)
inline

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.
See also
Default value

◆ Show()

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

Copies this ExportOptionsKit into the given ExportOptionsKit.

Parameters
out_kitThe ExportOptionsKit to populate with the contents of this ExportOptionsKit.

◆ ShowColorCompression()

bool HPS.Stream.ExportOptionsKit.ShowColorCompression ( out bool  out_state,
out uint  out_bits_per_color 
)
inline

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.

◆ ShowConnectivityCompression()

bool HPS.Stream.ExportOptionsKit.ShowConnectivityCompression ( out bool  out_state)
inline

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.

◆ ShowDefaultCamera()

bool HPS.Stream.ExportOptionsKit.ShowDefaultCamera ( out HPS.CameraKit  out_camera)
inline

Shows the default camera used for the export process.

Parameters
out_cameraThe camera being used as default.
Returns
A reference to this ExportOptionsKit.

◆ ShowImageCompression()

bool HPS.Stream.ExportOptionsKit.ShowImageCompression ( out bool  out_state,
out float  out_quality 
)
inline

Shows image compression state for uncompressed images in segment tree.

Parameters
out_stateWhether image compression is enabled or not.
out_qualityFloat 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 ( out bool  out_state,
out uint  out_bits_per_index 
)
inline

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.
out_bits_per_indexNumber 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 ( out bool  out_state,
out uint  out_bits_per_normal 
)
inline

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.

◆ ShowParameterCompression()

bool HPS.Stream.ExportOptionsKit.ShowParameterCompression ( out bool  out_state,
out uint  out_bits_per_parameter 
)
inline

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.

◆ ShowSerializeTristrips()

bool HPS.Stream.ExportOptionsKit.ShowSerializeTristrips ( out bool  out_state)
inline

Shows tristrips serialization state.

Parameters
out_stateWhether tristrips serialization is enabled or not.
Returns
true if a tristrips serialization setting was specified, false otherwise.

◆ ShowToolkit()

bool HPS.Stream.ExportOptionsKit.ShowToolkit ( out HPS.Stream.Toolkit  out_toolkit)
inline

Shows the root toolkit used for the export process.

Parameters
out_toolkitThe Toolkit used for the export process.
Returns
true if a toolkit was specified, false otherwise.

◆ ShowVertexCompression()

bool HPS.Stream.ExportOptionsKit.ShowVertexCompression ( out bool  out_state,
out uint  out_bits_per_vertex 
)
inline

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.

◆ UnsetColorCompression()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetColorCompression ( )
inline

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

Returns
A reference to this ExportOptionsKit.

◆ UnsetConnectivityCompression()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetConnectivityCompression ( )
inline

Removes connectivity (face list) compression state.

Returns
A reference to this ExportOptionsKit.

◆ UnsetDefaultCamera()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetDefaultCamera ( )
inline

Removes the default camera used for the export process.

Returns
A reference to this ExportOptionsKit.

◆ UnsetEventHandler()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetEventHandler ( IntPtr  in_type)
inline

Unsets the ExportEventHandler for the indicated ExportEvent type.

Parameters
in_typeThe type of the StreamExportEvent to unset.
Returns
A reference to this ExportOptionsKit.

◆ UnsetEventHandlers()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetEventHandlers ( )
inline

Unsets the ExportEventHandler for all ExportEvent types.

Returns
A reference to this ExportOptionsKit.

◆ UnsetEverything()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ExportOptionsKit.

Returns
A reference to this ExportOptionsKit.

◆ UnsetImageCompression()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetImageCompression ( )
inline

Removes image compression state for uncompressed images in segment tree.

Returns
A reference to this ExportOptionsKit.

◆ UnsetIndexCompression()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetIndexCompression ( )
inline

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

Returns
A reference to this ExportOptionsKit.

◆ UnsetNormalCompression()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetNormalCompression ( )
inline

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

Returns
A reference to this ExportOptionsKit.

◆ UnsetParameterCompression()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetParameterCompression ( )
inline

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

Returns
A reference to this ExportOptionsKit.

◆ UnsetSerializeTristrips()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetSerializeTristrips ( )
inline

Removes tristrips serialization state.

Returns
A reference to this ExportOptionsKit.

◆ UnsetToolkit()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetToolkit ( )
inline

Removes the toolkit used for the export process.

Returns
A reference to this ExportOptionsKit.

◆ UnsetVertexCompression()

HPS.Stream.ExportOptionsKit HPS.Stream.ExportOptionsKit.UnsetVertexCompression ( )
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