< Home

< Table of Contents

REFERENCE MANUAL

HPS.Exchange.ExportU3DOptionsKit Class Reference

The Exchange::ExportU3DOptionsKit class is a user space object. More...

Inheritance diagram for HPS.Exchange.ExportU3DOptionsKit:
HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this ExportU3DOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.ExportU3DOptionsKit in_kit)
 Check if the source ExportU3DOptionsKit is equivalent to this ExportU3DOptionsKit. More...
 
 ExportU3DOptionsKit ()
 The default constructor creates an empty ExportU3DOptionsKit object. More...
 
 ExportU3DOptionsKit (HPS.Exchange.ExportU3DOptionsKit in_kit)
 The copy constructor creates a new ExportU3DOptionsKit object that contains the same settings as the source ExportU3DOptionsKit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.Exchange.ExportU3DOptionsKit in_kit)
 Copies the source ExportU3DOptionsKit into this ExportU3DOptionsKit. More...
 
HPS.Exchange.ExportU3DOptionsKit SetCompression (byte in_level)
 Sets the level of compression to apply to tessellations in the U3D data for export. More...
 
HPS.Exchange.ExportU3DOptionsKit SetVersion (HPS.Exchange.U3D.Version in_version)
 Sets the version of the U3D data to export. More...
 
void Show (out HPS.Exchange.ExportU3DOptionsKit out_kit)
 Copies this ExportU3DOptionsKit into the given ExportU3DOptionsKit. More...
 
bool ShowCompression (out byte out_level)
 Shows the compression setting. More...
 
bool ShowVersion (out HPS.Exchange.U3D.Version out_version)
 Shows the version setting. More...
 
HPS.Exchange.ExportU3DOptionsKit UnsetCompression ()
 Removes the compression setting. More...
 
HPS.Exchange.ExportU3DOptionsKit UnsetEverything ()
 Removes all settings from this ExportU3DOptionsKit. More...
 
HPS.Exchange.ExportU3DOptionsKit UnsetVersion ()
 Removes the version setting. More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- 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.Exchange.ExportU3DOptionsKit 
GetDefault ()
 Creates an ExportU3DOptionsKit which contains the default settings. More...
 
static bool operator!= (HPS.Exchange.ExportU3DOptionsKit a, HPS.Exchange.ExportU3DOptionsKit b)
 
static bool operator== (HPS.Exchange.ExportU3DOptionsKit a, HPS.Exchange.ExportU3DOptionsKit 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

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The Exchange::ExportU3DOptionsKit class is a user space object.

It contains settings controlling how U3D data is exported via Exchange. Calling Exchange::ExportU3DOptionsKit::GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

HPS.Exchange.ExportU3DOptionsKit.ExportU3DOptionsKit ( )

The default constructor creates an empty ExportU3DOptionsKit object.

HPS.Exchange.ExportU3DOptionsKit.ExportU3DOptionsKit ( HPS.Exchange.ExportU3DOptionsKit  in_kit)

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_exchange_1_1_export_u3_d_options_kit" kindref="compound">ExportU3DOptionsKit</ref> to copy.

Member Function Documentation

override bool HPS.Exchange.ExportU3DOptionsKit.Empty ( )
virtual

Indicates whether this ExportU3DOptionsKit has any values set on it.

Returns
true if no values are set on this ExportU3DOptionsKit, false otherwise.

Reimplemented from HPS.Object.

bool HPS.Exchange.ExportU3DOptionsKit.Equals ( HPS.Exchange.ExportU3DOptionsKit  in_kit)

Check if the source ExportU3DOptionsKit is equivalent to this ExportU3DOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_exchange_1_1_export_u3_d_options_kit" kindref="compound">ExportU3DOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_exchange_1_1_export_u3_d_options_kit" kindref="compound">ExportU3DOptionsKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.Exchange.ExportU3DOptionsKit HPS.Exchange.ExportU3DOptionsKit.GetDefault ( )
static

Creates an ExportU3DOptionsKit 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. These values will be used for import unless an option is overridden by the options passed to File::ExportU3D.

Returns
An ExportU3DOptionsKit with the default settings.
override HPS.Type HPS.Exchange.ExportU3DOptionsKit.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.Exchange.ExportU3DOptionsKit.Set ( HPS.Exchange.ExportU3DOptionsKit  in_kit)

Copies the source ExportU3DOptionsKit into this ExportU3DOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_exchange_1_1_export_u3_d_options_kit" kindref="compound">ExportU3DOptionsKit</ref> to copy.
HPS.Exchange.ExportU3DOptionsKit HPS.Exchange.ExportU3DOptionsKit.SetCompression ( byte  in_level)

Sets the level of compression to apply to tessellations in the U3D data for export.

If no compression level is set, no compression will be applied. This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_u3_d_data.html#ae9321a865749efe613aa1d141dff426b">A3DRWParamsExportU3DData::m_ucMeshQualityValue</ulink>.

Parameters
in_levelThe level of compression to apply to tessellations in the <ref refid="class_h_p_s_1_1_exchange_1_1_u3_d" kindref="compound">U3D</ref> data for export. This value should be in the range [0, 100].
Returns
A reference to this ExportU3DOptionsKit.
HPS.Exchange.ExportU3DOptionsKit HPS.Exchange.ExportU3DOptionsKit.SetVersion ( HPS.Exchange.U3D.Version  in_version)

Sets the version of the U3D data to export.

This corresponds to the value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_export_u3_d_data.html#ae7d0446b90139bee7ccf7d0eef4a7204">A3DRWParamsExportU3DData::m_eU3DVersion</ulink>.

Parameters
in_versionThe version of the <ref refid="class_h_p_s_1_1_exchange_1_1_u3_d" kindref="compound">U3D</ref> data to export.
Returns
A reference to this ExportU3DOptionsKit.

Default value

void HPS.Exchange.ExportU3DOptionsKit.Show ( out HPS.Exchange.ExportU3DOptionsKit  out_kit)

Copies this ExportU3DOptionsKit into the given ExportU3DOptionsKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_exchange_1_1_export_u3_d_options_kit" kindref="compound">ExportU3DOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_exchange_1_1_export_u3_d_options_kit" kindref="compound">ExportU3DOptionsKit</ref>.
bool HPS.Exchange.ExportU3DOptionsKit.ShowCompression ( out byte  out_level)

Shows the compression setting.

Parameters
out_levelThe level of compression to apply to tessellations in the <ref refid="class_h_p_s_1_1_exchange_1_1_u3_d" kindref="compound">U3D</ref> data for export.
Returns
true if a compression setting was specified, false otherwise.
bool HPS.Exchange.ExportU3DOptionsKit.ShowVersion ( out HPS.Exchange.U3D.Version  out_version)

Shows the version setting.

Parameters
out_versionThe version of the <ref refid="class_h_p_s_1_1_exchange_1_1_u3_d" kindref="compound">U3D</ref> data to export.
Returns
true if a version setting was specified, false otherwise.
HPS.Exchange.ExportU3DOptionsKit HPS.Exchange.ExportU3DOptionsKit.UnsetCompression ( )

Removes the compression setting.

Returns
A reference to this ExportU3DOptionsKit.
HPS.Exchange.ExportU3DOptionsKit HPS.Exchange.ExportU3DOptionsKit.UnsetEverything ( )

Removes all settings from this ExportU3DOptionsKit.

Returns
A reference to this ExportU3DOptionsKit.
HPS.Exchange.ExportU3DOptionsKit HPS.Exchange.ExportU3DOptionsKit.UnsetVersion ( )

Removes the version setting.

Returns
A reference to this ExportU3DOptionsKit.

The documentation for this class was generated from the following file: