< Home

< Table of Contents

REFERENCE MANUAL

HPS.Exchange.ModelFileImportOptionsKit Class Reference

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

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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this ModelFileImportOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.ModelFileImportOptionsKit in_kit)
 Check if the source ModelFileImportOptionsKit is equivalent to this ModelFileImportOptionsKit. More...
 
override int GetHashCode ()
 
 ModelFileImportOptionsKit ()
 The default constructor creates an empty ModelFileImportOptionsKit object. More...
 
 ModelFileImportOptionsKit (HPS.Exchange.ModelFileImportOptionsKit in_kit)
 The copy constructor creates a new ModelFileImportOptionsKit object that contains the same settings as the source ModelFileImportOptionsKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.Exchange.ModelFileImportOptionsKit in_kit)
 Copies the source ModelFileImportOptionsKit into this ModelFileImportOptionsKit. More...
 
HPS.Exchange.ModelFileImportOptionsKit SetIFCEdges (bool in_state)
 Sets whether to import edges for IFC files When this is set to false the import time will decrease. More...
 
HPS.Exchange.ModelFileImportOptionsKit SetTessellationAccuracy (HPS.Exchange.Tessellation.Accuracy in_type, bool in_accurate_normals)
 Sets the accuracy of the tessellation that will be generated for BRep data. More...
 
HPS.Exchange.ModelFileImportOptionsKit SetTessellationAccuracy (HPS.Exchange.Tessellation.Accuracy in_type)
 Sets the accuracy of the tessellation that will be generated for BRep data. More...
 
HPS.Exchange.ModelFileImportOptionsKit SetTessellationLevel (HPS.Exchange.Tessellation.Level in_level)
 Sets the predefined quality of the tessellation that will be generated for BRep data. More...
 
HPS.Exchange.ModelFileImportOptionsKit SetTessellationLevel (HPS.Exchange.Tessellation.Chord.Limit in_limit_type, double in_limit, double in_angle_tolerance)
 Sets the user defined quality of the tessellation that will be generated for BRep data. More...
 
HPS.Exchange.ModelFileImportOptionsKit SetTessellationMaximumEdgeLength (double in_length)
 Sets the maximum length of triangle edges in the tessellation generated for BRep data. More...
 
HPS.Exchange.ModelFileImportOptionsKit SetTessellationPreservesUVPoints (bool in_state)
 Sets whether to keep parametric points as texture coordinates when generating the tessellation for BRep data. More...
 
void Show (out HPS.Exchange.ModelFileImportOptionsKit out_kit)
 Copies this ModelFileImportOptionsKit into the given ModelFileImportOptionsKit. More...
 
bool ShowIFCEdges (out bool out_state)
 Shows the IFC edges setting. More...
 
bool ShowTessellationAccuracy (out HPS.Exchange.Tessellation.Accuracy out_type, out bool out_accurate_normals)
 Shows the tessellation accuracy setting. More...
 
bool ShowTessellationLevel (out HPS.Exchange.Tessellation.Type out_type, out HPS.Exchange.Tessellation.Level out_level, out HPS.Exchange.Tessellation.Chord.Limit out_limit_type, out double out_limit, out double out_angle_tolerance)
 Shows the tessellation level setting. More...
 
bool ShowTessellationMaximumEdgeLength (out double out_length)
 Shows the tessellation maximum edge length setting. More...
 
bool ShowTessellationPreservesUVPoints (out bool out_state)
 Shows the tessellation UV preservation setting. More...
 
HPS.Exchange.ModelFileImportOptionsKit UnsetEverything ()
 Removes all settings from this ModelFileImportOptionsKit. More...
 
HPS.Exchange.ModelFileImportOptionsKit UnsetIFCEdges ()
 Removes the IFC edges setting. More...
 
HPS.Exchange.ModelFileImportOptionsKit UnsetTessellationAccuracy ()
 Removes the tessellation accuracy setting. More...
 
HPS.Exchange.ModelFileImportOptionsKit UnsetTessellationLevel ()
 Removes the tessellation level setting. More...
 
HPS.Exchange.ModelFileImportOptionsKit UnsetTessellationMaximumEdgeLength ()
 Removes the tessellation maximum edge length setting. More...
 
HPS.Exchange.ModelFileImportOptionsKit UnsetTessellationPreservesUVPoints ()
 Removes the tessellation UV preservation 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.ModelFileImportOptionsKit 
GetDefault ()
 Creates an ModelFileImportOptionsKit which contains the default settings. More...
 
static bool operator!= (HPS.Exchange.ModelFileImportOptionsKit a, HPS.Exchange.ModelFileImportOptionsKit b)
 
static bool operator== (HPS.Exchange.ModelFileImportOptionsKit a, HPS.Exchange.ModelFileImportOptionsKit 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::ModelFileImportOptionsKit class is a user space object.

It contains settings (potentially) controlling how data is imported via Exchange. This particular options kit is used when importing an A3DAsmModelFile directly (see Exchange::File::Import(void*,const ModelFileImportOptionsKit&)) and as such the options will only be used if the A3DAsmModelFile permits (e.g., tessellation options will only be used if tessellation needs to be generated and the A3DAsmModelFile has BRep data). Calling Exchange::ModelFileImportOptionsKit::GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

HPS.Exchange.ModelFileImportOptionsKit.ModelFileImportOptionsKit ( )

The default constructor creates an empty ModelFileImportOptionsKit object.

HPS.Exchange.ModelFileImportOptionsKit.ModelFileImportOptionsKit ( HPS.Exchange.ModelFileImportOptionsKit  in_kit)

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_exchange_1_1_model_file_import_options_kit" kindref="compound">ModelFileImportOptionsKit</ref> to copy.

Member Function Documentation

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

Indicates whether this ModelFileImportOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

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

Check if the source ModelFileImportOptionsKit is equivalent to this ModelFileImportOptionsKit.

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

Creates an ModelFileImportOptionsKit 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::Import(void*,const ModelFileImportOptionsKit&).

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

Copies the source ModelFileImportOptionsKit into this ModelFileImportOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_exchange_1_1_model_file_import_options_kit" kindref="compound">ModelFileImportOptionsKit</ref> to copy.
HPS.Exchange.ModelFileImportOptionsKit HPS.Exchange.ModelFileImportOptionsKit.SetIFCEdges ( bool  in_state)

Sets whether to import edges for IFC files When this is set to false the import time will decrease.

It is still possible to achieve visual fidelity by turning on hard edge visibility.

Parameters
in_stateWhether to import edges for an IFC file.
Returns
A reference to this ModelFileImportOptionsKit.

Default value

HPS.Exchange.ModelFileImportOptionsKit HPS.Exchange.ModelFileImportOptionsKit.SetTessellationAccuracy ( HPS.Exchange.Tessellation.Accuracy  in_type,
bool  in_accurate_normals 
)

Sets the accuracy of the tessellation that will be generated for BRep data.

Parameters
in_typeThe accuracy to use for tessellation generation.
in_accurate_normalsWhether to compute surface normals when performing accurate tessellation. This only applies if in_type is set to <ref refid="class_h_p_s_1_1_exchange_1_1_tessellation_1a1f4b490fe9d73489bd6164d9acc3d106a2b1a4a18d200231b2e6c79dbb486f6a5" kindref="member">Tessellation::Accuracy::Accurate</ref>. This correspond to the (negated) value that will be passed to <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_tessellation_data.html#a51d14d591da50a1d28fd6a61d7ed7eab">A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation</ulink>.
Returns
A reference to this ModelFileImportOptionsKit.

Default value

HPS.Exchange.ModelFileImportOptionsKit HPS.Exchange.ModelFileImportOptionsKit.SetTessellationAccuracy ( HPS.Exchange.Tessellation.Accuracy  in_type)

Sets the accuracy of the tessellation that will be generated for BRep data.

Parameters
in_typeThe accuracy to use for tessellation generation.
Returns
A reference to this ModelFileImportOptionsKit.

Default value

HPS.Exchange.ModelFileImportOptionsKit HPS.Exchange.ModelFileImportOptionsKit.SetTessellationLevel ( HPS.Exchange.Tessellation.Level  in_level)

Sets the predefined quality of the tessellation that will be generated for BRep data.

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_tessellation_data.html#a7949f7f08c25a321ce73843676072eb1">A3DRWParamsTessellationData::m_eTessellationLevelOfDetail</ulink>.

Parameters
in_levelThe predefined quality of the tessellation that will be generated for BRep data.
Returns
A reference to this ModelFileImportOptionsKit.

Default value

HPS.Exchange.ModelFileImportOptionsKit HPS.Exchange.ModelFileImportOptionsKit.SetTessellationLevel ( HPS.Exchange.Tessellation.Chord.Limit  in_limit_type,
double  in_limit,
double  in_angle_tolerance 
)

Sets the user defined quality of the tessellation that will be generated for BRep data.

This implicitly sets <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/struct_a3_d_r_w_params_tessellation_data.html#a7949f7f08c25a321ce73843676072eb1">A3DRWParamsTessellationData::m_eTessellationLevel</ulink> to <ulink url="http://docs.techsoft3d.com/exchange/latest/exchange_ref_manual/group__a3d__read.html#ggac1fe96a5b9772683a41182babe1559f4ab5aec16efd29ca9df5969341c5c0a245">kA3DTessLODUserDefined</ulink>.

Parameters
in_limit_typeThe type of the chord limit to be specified.
in_limitEither the ratio of the tessellation chord height to the bounding box height which should be in the range [50, 10000], or the maximum distance between the surface definition and the tessellation approximation, depending on the preceding argument.
in_angle_toleranceThe maximum angle in degrees between two consecutive wire elements in the generated tessellation which should be in the range [10, 40]. 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_tessellation_data.html#a58e1c697c1fd5243e338485edfaf4e8d">A3DRWParamsTessellationData::m_dAngleToleranceDeg</ulink>.
Returns
A reference to this ModelFileImportOptionsKit.
HPS.Exchange.ModelFileImportOptionsKit HPS.Exchange.ModelFileImportOptionsKit.SetTessellationMaximumEdgeLength ( double  in_length)

Sets the maximum length of triangle edges in the tessellation generated for BRep data.

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_tessellation_data.html#a124a4c06b502d452312a70c1cd92eb09">A3DRWParamsTessellationData::m_dMaximalTriangleEdgeLength</ulink>.

Parameters
in_lengthThe maximum length of triangle edges in the tessellation generated for BRep data. The value must be non-negative, and if set to 0.0, the length will not be used when generating the tessellation.
Returns
A reference to this ModelFileImportOptionsKit.

Default value

HPS.Exchange.ModelFileImportOptionsKit HPS.Exchange.ModelFileImportOptionsKit.SetTessellationPreservesUVPoints ( bool  in_state)

Sets whether to keep parametric points as texture coordinates when generating the tessellation for BRep data.

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_tessellation_data.html#a13ff3862be1e4ff11a00fcf6c9373e29">A3DRWParamsTessellationData::m_bKeepUVPoints</ulink>.

Parameters
in_stateWhether to keep parametric points as texture coordinates when generating the tessellation for BRep data.
Returns
A reference to this ModelFileImportOptionsKit.

Default value

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

Copies this ModelFileImportOptionsKit into the given ModelFileImportOptionsKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_exchange_1_1_model_file_import_options_kit" kindref="compound">ModelFileImportOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_exchange_1_1_model_file_import_options_kit" kindref="compound">ModelFileImportOptionsKit</ref>.
bool HPS.Exchange.ModelFileImportOptionsKit.ShowIFCEdges ( out bool  out_state)

Shows the IFC edges setting.

Parameters
out_stateWhether to import edges for an IFC file.
Returns
true if an IFC edge setting was specified, false otherwise.
bool HPS.Exchange.ModelFileImportOptionsKit.ShowTessellationAccuracy ( out HPS.Exchange.Tessellation.Accuracy  out_type,
out bool  out_accurate_normals 
)

Shows the tessellation accuracy setting.

Parameters
out_typeThe type of the tessellation accuracy which was specified.
out_accurate_normalsWhether to compute surface normals when performing accurate tessellation. This only applies if out_type is <ref refid="class_h_p_s_1_1_exchange_1_1_tessellation_1a1f4b490fe9d73489bd6164d9acc3d106a2b1a4a18d200231b2e6c79dbb486f6a5" kindref="member">Tessellation::Accuracy::Accurate</ref>.
Returns
true if a tessellation accuracy setting was specified, false otherwise.
bool HPS.Exchange.ModelFileImportOptionsKit.ShowTessellationLevel ( out HPS.Exchange.Tessellation.Type  out_type,
out HPS.Exchange.Tessellation.Level  out_level,
out HPS.Exchange.Tessellation.Chord.Limit  out_limit_type,
out double  out_limit,
out double  out_angle_tolerance 
)

Shows the tessellation level setting.

Parameters
out_typeThe type of the tessellation level setting which was specified.
out_levelThe predefined quality of the tessellation that will be generated for BRep data. This is only valid if out_type is <ref refid="class_h_p_s_1_1_exchange_1_1_tessellation_1a35aa00b156f9e38f50dc32bafc6f8ce0aeb6d8ae6f20283755b339c0dc273988b" kindref="member">Tessellation::Type::Standard</ref>.
out_limit_typeThe type of chord limit which was specified. This is only valid if out_type is <ref refid="class_h_p_s_1_1_exchange_1_1_tessellation_1a35aa00b156f9e38f50dc32bafc6f8ce0a90589c47f06eb971d548591f23c285af" kindref="member">Tessellation::Type::Custom</ref>.
out_limitThe chord limit to use to generate tessellation for BRep data. Its interpretation depends on the preceding argument. This is only valid if out_type is <ref refid="class_h_p_s_1_1_exchange_1_1_tessellation_1a35aa00b156f9e38f50dc32bafc6f8ce0a90589c47f06eb971d548591f23c285af" kindref="member">Tessellation::Type::Custom</ref>.
out_angle_toleranceThe maximum angle in degrees between two consecutive wire elements in the generated tessellation. This is only valid if out_type is <ref refid="class_h_p_s_1_1_exchange_1_1_tessellation_1a35aa00b156f9e38f50dc32bafc6f8ce0a90589c47f06eb971d548591f23c285af" kindref="member">Tessellation::Type::Custom</ref>.
Returns
true if a tessellation level setting was specified, false otherwise.
bool HPS.Exchange.ModelFileImportOptionsKit.ShowTessellationMaximumEdgeLength ( out double  out_length)

Shows the tessellation maximum edge length setting.

Returns
true if a tessellation maximum edge length setting was specified, false otherwise.
bool HPS.Exchange.ModelFileImportOptionsKit.ShowTessellationPreservesUVPoints ( out bool  out_state)

Shows the tessellation UV preservation setting.

Parameters
out_stateWhether to keep parametric points as texture coordinates when generating the tessellation for BRep data.
Returns
true if a tessellation UV preservation setting was specified, false otherwise.
HPS.Exchange.ModelFileImportOptionsKit HPS.Exchange.ModelFileImportOptionsKit.UnsetEverything ( )

Removes all settings from this ModelFileImportOptionsKit.

Returns
A reference to this ModelFileImportOptionsKit.
HPS.Exchange.ModelFileImportOptionsKit HPS.Exchange.ModelFileImportOptionsKit.UnsetIFCEdges ( )

Removes the IFC edges setting.

Returns
A reference to this ModelFileImportOptionsKit.
HPS.Exchange.ModelFileImportOptionsKit HPS.Exchange.ModelFileImportOptionsKit.UnsetTessellationAccuracy ( )

Removes the tessellation accuracy setting.

Returns
A reference to this ModelFileImportOptionsKit.
HPS.Exchange.ModelFileImportOptionsKit HPS.Exchange.ModelFileImportOptionsKit.UnsetTessellationLevel ( )

Removes the tessellation level setting.

Returns
A reference to this ModelFileImportOptionsKit.
HPS.Exchange.ModelFileImportOptionsKit HPS.Exchange.ModelFileImportOptionsKit.UnsetTessellationMaximumEdgeLength ( )

Removes the tessellation maximum edge length setting.

Returns
A reference to this ModelFileImportOptionsKit.
HPS.Exchange.ModelFileImportOptionsKit HPS.Exchange.ModelFileImportOptionsKit.UnsetTessellationPreservesUVPoints ( )

Removes the tessellation UV preservation setting.

Returns
A reference to this ModelFileImportOptionsKit.

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