Exchange

class HPS.Exchange : public IDisposable

The Exchange class contains objects and enumerations used for importing and exporting CAD files via Exchange.

Public Types

enum AnnotationCaptureFitting

Enumerates the type of data in the scene to use to generate cameras for annotation captures.

Values:

PMIOnly

Use only the bounds of the PMI referenced by the annotation capture to compute the camera.

ModelAndPMI

Use the bounds of the model and the PMI referenced by the annotation capture to compute the camera.

enum BIMRelationshipType

Enumerates the BIM relationship types.

Values:

ContainedInSpatialStructure

Aggregates

VoidsElement

FillsElement

SpaceBoundary

ConnectsPathElements

enum BRepMode

Enumerates the ways in which to import BRep and tessellation data for files imported via Exchange.

Values:

TessellationOnly

BRepOnly

BRepAndTessellation

enum CurveType

Enumerates the types of curves supported by Exchange

Values:

Blend

Blend boundary curve (kA3DTypeCrvBlend02Boundary ).

NURBS

NURBS curve (kA3DTypeCrvNurbs ).

Circle

Circle (kA3DTypeCrvCircle ).

Composite

Array of oriented curves (kA3DTypeCrvComposite ).

CurveOnSurface

Curve defined by a UV curve on a surface (kA3DTypeCrvOnSurf ).

Ellipse

Ellipse (kA3DTypeCrvEllipse ).

Equation

Curve described by an equation (kA3DTypeCrvEquation ).

Helix

Helix (kA3DTypeCrvHelix ).

Hyperbola

Hyperbola (kA3DTypeCrvHyperbola ).

Intersection

Intersection between two surfaces (kA3DTypeCrvIntersection ).

Line

Line (kA3DTypeCrvLine ).

Offset

Offset curve (kA3DTypeCrvOffset ).

Parabola

Parabola (kA3DTypeCrvParabola ).

Polyline

Polyhedric curve (kA3DTypeCrvPolyLine ).

Transform

Transformed curve (kA3DTypeCrvTransform ).

enum ImportMode

Enumerates the ways in which to perform file import via Exchange.

Values:

Complete

Incremental

enum LoadStatus

Enumerates the various load statuses for a ProductOccurrence.

Values:

Unknown

Loaded

VisualizationOnly

PartiallyLoaded

NotLoaded

enum SurfaceType

Enumerates the types of surfaces supported by Exchange

Values:

Blend01

Blend Type 1 surface (kA3DTypeSurfBlend01).

Blend02

Blend Type 2 surface (kA3DTypeSurfBlend02).

Blend03

Blend Type 3 surface (kA3DTypeSurfBlend03).

Blend04

Blend Type 4 surface (kA3DTypeSurfBlend04).

NURBS

NURBS surface (kA3DTypeSurfNurbs ).

Cone

Conical surface (kA3DTypeSurfCone ).

Cylinder

Cylindrical surface (kA3DTypeSurfCylinder ).

Offset

Offset surface (kA3DTypeSurfOffset ).

Pipe

Pipe surface (kA3DTypeSurfPipe ).

Plane

Planar surface (kA3DTypeSurfPlane ).

Ruled

Ruled surface (kA3DTypeSurfRuled ).

Sphere

Spherical surface (kA3DTypeSurfSphere ).

Revolution

Revolution surface (kA3DTypeSurfRevolution ).

Extrusion

An Extrusion (kA3DTypeSurfExtrusion ).

FromCurve

Surface defined from a curve (kA3DTypeSurfFromCurves).

Torus

Torus surface (kA3DTypeSurfTorus).

Transform

Transform (kA3DTypeSurfTransform ).

enum Units

Enumerates the units for files imported via Exchange.

Values:

Unknown

Unknown unit type (kA3DUnitUnknown).

Point

Point (1/72 of an inch) units (kA3DUnitPoint).

Inch

Inch units (kA3DUnitInch).

Millimeter

Millimeter units (kA3DUnitMillimeter).

Centimeter

Centimeter units (kA3DUnitCentimeter).

Pica

Pica (1/72 of a foot) units (kA3DUnitPicas).

Foot

Foot units (kA3DUnitFoot).

Yard

Yard units (kA3DUnitYard).

Meter

Meter units (kA3DUnitMeter).

Kilometer

Kilometer units (kA3DUnitKilometer).

Mile

Mile units (kA3DUnitMile).

enum UnloadMode

Enumerates the ways in which a ProductOccurrence can be unloaded.

Values:

ExchangeAndVisualization

ExchangeOnly

Public Functions

void Dispose ()

Exchange (HPS.Exchange in_that)

class BIMData : public HPS.Sprocket

BIM related data inside the model.

Public Functions

BIMData ()

The default constructor creates an empty BIMData object.

BIMData (HPS.Exchange.BIMData in_bim_data)

The copy constructor creates a new BIMData object that is associated with the same data as the source BIMData.

Param in_bim_data

The source BIMData to copy.

override void Dispose ()

bool Equals (HPS.Exchange.BIMData in_bim_data)

Check if the source BIMData is equivalent to this BIMData.

Param in_bim_data

The source BIMData to compare to this BIMData.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

HPS.Exchange.BIMRelationshipEntity[] GetRelatedEntities (HPS.Exchange.Component in_component, HPS.Exchange.BIMRelationshipType in_relationship_type)

Get an array of BIMRelationshipEntity that are related to the component given.

Param in_component

the component used to search related BIMRelationshipEntity.

Param in_relationship_type

the type of BIMRelationship used for the search.

Return

an array of BIMRelationshipEntity.

HPS.Exchange.BIMRelationshipEntity[] GetRelatingEntities (HPS.Exchange.Component in_component, HPS.Exchange.BIMRelationshipType in_relationship_type)

Get an array of BIMRelationshipEntity that are relating to the component given.

Param in_component

the component used to search relating BIMRelationshipEntity.

Param in_relationship_type

the type of BIMRelationship used for the search.

Return

an array of BIMRelationshipEntity.

HPS.Exchange.BIMRelationship[] GetRelationships (HPS.Exchange.Component in_component)

Get an array of all relationships that target the component given.

Param in_component

the component whose relationships are requested.

Return

the array of BIMRelationship for the component.

HPS.Exchange.BIMType[] GetTypes ()

Get an array of BIMType present in this model.

Return

the array of BIMType for this model.

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.

Public Static Functions

bool operator!= (HPS.Exchange.BIMData a, HPS.Exchange.BIMData b)

bool operator== (HPS.Exchange.BIMData a, HPS.Exchange.BIMData b)

class BIMRelationship : public HPS.Sprocket

BIM relationship

Public Functions

BIMRelationship ()

The default constructor creates an empty BIMRelationship object.

BIMRelationship (HPS.Exchange.BIMRelationship in_relationship)

The copy constructor creates a new BIMRelationship object that is associated with the same data as the source BIMRelationship.

Param in_relationship

The source BIMRelationship to copy.

override void Dispose ()

bool Equals (HPS.Exchange.BIMRelationship in_relationship)

Check if the source BIMRelationship is equivalent to this BIMRelationship.

Param in_relationship

The source BIMRelationship to compare to this BIMRelationship.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

HPS.Exchange.BIMRelationshipEntity[] GetRelatedEntities ()

Get an array of related BIMRelationshipEntity.

Return

an array of BIMRelationshipEntity acting as related in the BIMRelationship.

HPS.Exchange.BIMRelationshipEntity GetRelatingEntity ()

Get the relating BIMRelationshipEntity.

Return

the RelatingshipEntity acting as relating in the BIMRelationship.

HPS.Exchange.BIMRelationshipType GetType ()

Get the type of this BIMRelationship.

Return

the BIMRelationshipType of this BIMRelationship.

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.

Public Static Functions

bool operator!= (HPS.Exchange.BIMRelationship a, HPS.Exchange.BIMRelationship b)

bool operator== (HPS.Exchange.BIMRelationship a, HPS.Exchange.BIMRelationship b)

class BIMRelationshipEntity : public HPS.Sprocket

Entity inside a BIM relationship

Public Functions

BIMRelationshipEntity ()

The default constructor creates an empty BIMRelationshipEntity object.

BIMRelationshipEntity (HPS.Exchange.BIMRelationshipEntity in_that)

The copy constructor creates a new BIMRelationshipEntity object that is associated with the same data as the source BIMRelationshipEntity.

Param in_that

The source BIMRelationshipEntity to copy.

override void Dispose ()

bool Equals (HPS.Exchange.BIMRelationshipEntity in_relationshipEntity)

Check if the source BIMRelationshipEntity is equivalent to this BIMRelationshipEntity.

Param in_relationshipEntity

The source BIMRelationshipEntity to compare to this BIMRelationshipEntity.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

HPS.Exchange.Component GetComponent ()

Get the component for this entity.

Return

the component for this entity of an empty component is the element is not loaded (such as openings).

override int GetHashCode ()

string GetName ()

Get the name of this BIMRelationshipEntity.

Return

the name of this BIMRelationshipEntity.

string GetName (bool use_generated_if_needed)

Get the name of this BIMRelationshipEntity.

Param use_generated_if_needed

Whether to use the generated name if the component has no name.

Return

the name of this BIMRelationshipEntity.

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.

Public Static Functions

bool operator!= (HPS.Exchange.BIMRelationshipEntity a, HPS.Exchange.BIMRelationshipEntity b)

bool operator== (HPS.Exchange.BIMRelationshipEntity a, HPS.Exchange.BIMRelationshipEntity b)

class BIMType : public HPS.Sprocket

BIM Type

Public Functions

BIMType ()

The default constructor creates an empty BIMType object.

BIMType (HPS.Exchange.BIMType in_bim_type)

The copy constructor creates a new BIMType object that is associated with the same data as the source BIMType.

Param in_bim_type

The source BIMType to copy.

override void Dispose ()

bool Equals (HPS.Exchange.BIMType in_bim_type)

Check if the source BIMType is equivalent to this BIMType.

Param in_bim_type

The source BIMType to compare to this BIMType.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

HPS.Exchange.Component[] GetComponents ()

Get the components that are associated with this type.

Return

an array of components that are associated with this type.

override int GetHashCode ()

string GetName ()

Get the name of this type.

Return

the name of this type.

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.

Public Static Functions

bool operator!= (HPS.Exchange.BIMType a, HPS.Exchange.BIMType b)

bool operator== (HPS.Exchange.BIMType a, HPS.Exchange.BIMType b)

class CADModel : public HPS.CADModel

The CADModel class is a smart pointer. It represents an A3DAsmModelFile in Exchange. The primary purpose of this class is simply to provide access to the underlying A3DAsmModelFile pointer for use by Exchange library functions.

Public Functions

CADModel ()

The default constructor creates an uninitialized CADModel object. The Type() function will return Type.None.

CADModel (HPS.CADModel in_that)

This constructor creates an Exchange.CADModel object that shares the underlying smart-pointer of the source HPS.CADModel. The copy will only be successful if the source component is really an upcast of an Exchange.CADModel object. Otherwise the copy will fail and the resulting Exchange.CADModel will be invalid.

Param in_that

The source HPS.CADModel to copy.

CADModel (HPS.Component in_that)

This constructor creates a CADModel object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange.CADModel object. Otherwise the copy will fail and the resulting Exchange.CADModel will be invalid.

Param in_that

The source Component to copy.

CADModel (HPS.Exchange.CADModel in_that)

This constructor creates an Exchange.CADModel object that shares the underlying smart-pointer of the source HPS.CADModel. The copy will only be successful if the source component is really an upcast of an Exchange.CADModel object. Otherwise the copy will fail and the resulting Exchange.CADModel will be invalid.

Param in_that

The source HPS.CADModel to copy.

override void Dispose ()

HPS.Exchange.Layer[] GetAllLayers ()

Get all layers defined in this CAD Model.

Return

A list of all layers defined in this CAD Model.

HPS.Exchange.BIMData GetBIMData ()

Gets a const reference to BIM data. Only formats which support the concept of BIM data can have a non empty BIM Data.

Return

the BIM data for this CADModel.

HPS.Component GetComponentFromEntity (IntPtr in_entity)

Gets the Component associated with the given A3DEntity pointer (if any).

Param in_entity

The A3DEntity pointer from which to find the associated Component.

Return

The Component associated with the given A3DEntity pointer, or an empty component if there is no such Component.

HPS.Exchange.Configuration[] GetConfigurations ()

Gets a list of configurations for this CADModel (if any). Only formats which support the concept of configurations can return a non-empty array, and only files of those formats which contain configurations will return a non-empty array.

Return

The list of configurations for this CADModel.

string[] GetCurrentConfiguration ()

Gets the current configuration for this CADModel if it exists. Only formats which support the concept of configurations can have a current configuration, and only files of those formats which contain configurations will have a current configuration.

Return

The current configuration for this CADModel.

bool GetEntityOwnership ()

Whether this CADModel owns the associated A3DAsmModelFile or not. If this CADModel owns the associated A3DAsmModelFile, when it is deleted (via Exchange.CADModel.Delete), it will delete not only the associated Visualize components, segments and geometry but also the A3DAsmModelFile via A3DAsmModelFileDelete. If this CADModel does not own the associated A3DAsmModelFile, when it is deleted, it will only delete the associated Visualize components, segments and geometry, but not the A3DAsmModelFile. It will be up to the user to ensure the A3DAsmModelFile is deleted to reclaim any memory it has allocated in this case.

Return

Whether this CADModel owns the associated A3DAsmModelFile.

IntPtr GetExchangeEntity ()

Gets the A3DEntity pointer corresponding to this Exchange.CADModel.

Return

The A3DEntity pointer corresponding to this Exchange.CADModel.

HPS.Exchange.Sheet[] GetSheets ()

Gets a list of sheets for this CADModel (if any). Only formats which support the concept of sheets can return a non-empty array.

Return

The list of sheets for this CADModel

void HideAllPMI (HPS.Canvas in_canvas)

Forces the visibility of all PMI off in the given Canvas and layer. This will undo any hides, shows, isolates, or other highlights performed on PMI components contained within this CADModel via ComponentPath calls.

Param in_canvas

The Canvas in which to perform the the operation

void HideAllPMI (HPS.Canvas in_canvas, ulong in_layer)

Forces the visibility of all PMI off in the given Canvas and layer. This will undo any hides, shows, isolates, or other highlights performed on PMI components contained within this CADModel via ComponentPath calls.

Param in_canvas

The Canvas in which to perform the the operation

Param in_layer

The layer in the Canvas in which to perform the operation.

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.

HPS.Exchange.ReloadNotifier Reload ()

Asynchronously reloads this CADModel. This will delete all underlying subcomponents and then reparse the underlying Exchange data.

HPS.Exchange.ReloadNotifier Reload (HPS.Exchange.TessellationOptionsKit in_options)

Asynchronously reloads this CADModel. This will delete all underlying subcomponents and then reparse the underlying Exchange data.

Param in_options

The options to use to generate tessellations for new Components (if necessary).

HPS.Exchange.ReloadNotifier Reload (HPS.Exchange.TessellationOptionsKit in_options, HPS.Exchange.TranslationOptionsKit in_translation_options)

Asynchronously reloads this CADModel. This will delete all underlying subcomponents and then reparse the underlying Exchange data.

Param in_options

The options to use to generate tessellations for new Components (if necessary).

Param in_translation_options

The options to use for translation from Exchange BRep to Parasolid. This option only applies if a file was loaded via the ExchangeParasolid module and there are components underlying this component that need to be translated to Parasolid.

bool ReplaceExchangeEntity (HPS.Component in_component, IntPtr in_a3d_entity)

Replace the Exchange entity associated with the provided component. You are required to sync the HPS model tree with the PRC structures after calling this via Reload.

See

Reload

Param in_component

The component whose entity is to be replaced.

Param in_a3d_entity

The new entity that will be associated with in_component.

Return

true if the new entity was associated successfully, false otherwise.

void SetAllPMIInFront (bool in_enable, HPS.Canvas in_canvas)

Forces all of the PMI in this CADModel to be rendered in front of the other geometry. contained within this CADModel via ComponentPath calls.

Param in_enable

Dictates whether the pmi will be forced in front or not.

Param in_canvas

The Canvas in which to perform the the operation

void SetAllPMIInFront (bool in_enable, HPS.Canvas in_canvas, ulong in_layer)

Forces all of the PMI in this CADModel to be rendered in front of the other geometry. contained within this CADModel via ComponentPath calls.

Param in_enable

Dictates whether the pmi will be forced in front or not.

Param in_canvas

The Canvas in which to perform the the operation

Param in_layer

The layer in the Canvas in which to perform the operation.

void ShowAllPMI (HPS.Canvas in_canvas)

Forces the visibility of all PMI on in the given Canvas and layer. This will undo any hides, shows, isolates, or other highlights performed on PMI components contained within this CADModel via ComponentPath calls.

Param in_canvas

The Canvas in which to perform the the operation

void ShowAllPMI (HPS.Canvas in_canvas, ulong in_layer)

Forces the visibility of all PMI on in the given Canvas and layer. This will undo any hides, shows, isolates, or other highlights performed on PMI components contained within this CADModel via ComponentPath calls.

Param in_canvas

The Canvas in which to perform the the operation

Param in_layer

The layer in the Canvas in which to perform the operation.

void Tessellate (HPS.Exchange.TessellationOptionsKit in_options)

Re-tessellate the given CADModel with the provided options. Tessellation occurs at the representation item level in Exchange. All representation items underneath this CADModel will be re-tessellated with the provided options. Additionally, only components for which there is BRep data can the tessellation be regenerated.

Param in_options

The options to use to generate the new tessellation for this CADModel

HPS.Exchange.TranslationNotifier Translate (HPS.Exchange.TranslationOptionsKit in_translation_options)

Asynchronously translates this CADModel into an array of Parasolid parts, using the options provided. A valid Parasolid session is required for this function to succeed. If this CADModel was imported in tessellation only mode an empty Parasolid assembly will be returned.

Param in_translation_options

Options used during the translation.

Return

An TranslationNotifier object that can be used to query the import progress and status.

class Capture : public HPS.Capture

The Capture class is a smart pointer. It represents an A3DMkpView in Exchange. The primary purpose of this class is simply to provide access to the underlying A3DMkpView pointer for use by Exchange library functions.

Public Functions

HPS.View Activate ()

Activates this capture.

Return

the View.

HPS.View Activate (HPS.ComponentPath in_capture_path)

Activates this capture.

Param in_capture_path

The capture path to operate on.

Return

the View.

Capture ()

The default constructor creates an uninitialized Capture object. The Type() function will return Type.None.

Capture (HPS.Capture in_that)

This constructor creates an Exchange.Capture object that shares the underlying smart-pointer of the source HPS.Capture. The copy will only be successful if the source component is really an upcast of an Exchange.Capture object. Otherwise the copy will fail and the resulting Exchange.Capture will be invalid.

Param in_that

The source HPS.Capture to copy.

Capture (HPS.Component in_that)

This constructor creates a Capture object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange.Capture object. Otherwise the copy will fail and the resulting Exchange.Capture will be invalid.

Param in_that

The source Component to copy.

Capture (HPS.Exchange.Capture in_that)

This constructor creates an Exchange.Capture object that shares the underlying smart-pointer of the source HPS.Capture. The copy will only be successful if the source component is really an upcast of an Exchange.Capture object. Otherwise the copy will fail and the resulting Exchange.Capture will be invalid.

Param in_that

The source HPS.Capture to copy.

override void Dispose ()

IntPtr GetExchangeEntity ()

Gets the A3DEntity pointer corresponding to this Exchange.Capture.

Return

The A3DEntity pointer corresponding to this Exchange.Capture.

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.

class CommonMeasurementOperator : public HPS.Operator

The CommonMeasurementOperator class defines an operator which contains many often used functions when inserting measurements. Users can build a custom measurement operator by deriving from this class. This operator requires the model be loaded using the Exchange bridge, and the model must contain B-rep.

Subclassed by HPS.Exchange.MeasurementOperator

Public Types

enum Tags

Values:

Name

MeasurementType

Radius

Inverted

VectorX

VectorY

VectorZ

Public Functions

CommonMeasurementOperator ()

CommonMeasurementOperator (HPS.Exchange.CADModel in_cad_model)

CommonMeasurementOperator (HPS.Exchange.CADModel in_cad_model, HPS.MouseButtons in_mouse_trigger)

CommonMeasurementOperator (HPS.Exchange.CADModel in_cad_model, HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)

CommonMeasurementOperator (HPS.Exchange.CommonMeasurementOperator in_that)

void DeleteMeasurements ()

Deletes all measurements

override void Dispose ()

HPS.Exchange.CADModel GetCADModel ()

HPS.MaterialMappingKit GetMaterial ()

Returns the material used for the measurements

HPS.SegmentKey GetMeasurementSegment ()

Returns the top measurement segment containing all measurements

override string GetName ()

Returns the name of the operator.

ulong GetPrecision ()

Returns the precision used in the measurement (number of digits after the decimal point)

HPS.TextAttributeKit GetTextAttributes ()

Returns the text attributes used for the measurements

override void OnViewAttached (HPS.View in_attached_view)

This function is called whenever a view is attached to this operator.

Param in_attached_view

The view attached to this operator.

override void OnViewDetached (HPS.View in_detached_view)

This function is called whenever a view is detached from this operator.

Param in_detached_view

The view detached from this operator.

void SetCADModel (HPS.Exchange.CADModel in_cad_model)

void SetMaterial (HPS.MaterialMappingKit in_material_mapping)

Changes the material used for the measurements. Affects all measurements, even those already inserted.

void SetPrecision (ulong in_precision)

Changes the precision used in the measurement (number of digits after the decimal point) Only affects future measurements.

void SetTextAttribute (HPS.TextAttributeKit in_text_attributes)

Changes the text attributes used for the measurements. Affects all measurements, even those already inserted.

Public Static Functions

string GetNewMeasurementSegmentName (string in_prefix)

class MeasurementDeletedEvent : public HPS.Event

Public Functions

override HPS.Event Clone ()

Allocates and returns a copy of this MeasurementDeletedEvent.

Return

A copy of this MeasurementDeletedEvent.

override void Dispose ()

MeasurementDeletedEvent ()

The default constructor creates an empty MeasurementDeletedEvent object.

MeasurementDeletedEvent (HPS.Event in_event)

This constructor converts an Event Object to a MeasurementDeletedEvent object.

Param in_event

The Event Object to be converted.

MeasurementDeletedEvent (HPS.Exchange.CommonMeasurementOperator.MeasurementDeletedEvent in_that)

MeasurementDeletedEvent (string in_measurement_name, HPS.View in_view)

Properties

string measurement_name { get; set; }

HPS.View view { get; set; }

class MeasurementInsertedEvent : public HPS.Event

Public Functions

override HPS.Event Clone ()

Allocates and returns a copy of this MeasurementInsertedEvent.

Return

A copy of this MeasurementInsertedEvent.

override void Dispose ()

MeasurementInsertedEvent ()

The default constructor creates an empty MeasurementInsertedEvent object.

MeasurementInsertedEvent (HPS.Event in_event)

This constructor converts an Event Object to a MeasurementInsertedEvent object.

Param in_event

The Event Object to be converted.

MeasurementInsertedEvent (HPS.Exchange.CommonMeasurementOperator.MeasurementInsertedEvent in_that)

MeasurementInsertedEvent (HPS.Key in_measurement_key, HPS.View in_view)

Properties

HPS.Key measurement_key { get; set; }

HPS.View view { get; set; }

class Component : public HPS.Component

The Component class is a smart pointer. It represents a variety of Exchange components. The primary purpose of this class is simply to provide access to the underlying A3DEntity pointer for use by Exchange library functions.

Subclassed by HPS.Exchange.ProductOccurrence, HPS.Exchange.Sheet

Public Functions

bool AddTransform (HPS.MatrixKit in_transform)

Appends a transform to the underlying PRC data associated with this component. Only components of type ExchangeProductOccurrence, or components that have the type ExchangeRepresentationItemMask can have transforms applied to them. Additionally, AddTransform does not work on Exchange models which have a Drawing structure to them. This would include CATDrawing files and 2D DWG files loaded through Exchange. Any attempt to use this function on those models will produce a warning.

Param in_transform

The transform to apply to this component.

Return

true if transform was applied correctly, false otherwise.

Component ()

The default constructor creates an uninitialized Exchange.Component object. The Type() function will return Type.None.

Component (HPS.Component in_that)

This constructor creates an Exchange.Component object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange.Component object. Otherwise the copy will fail and the resulting Exchange.Component will be invalid.

Param in_that

The source Component to copy.

Component (HPS.Exchange.Component in_that)

This constructor creates an Exchange.Component object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange.Component object. Otherwise the copy will fail and the resulting Exchange.Component will be invalid.

Param in_that

The source Component to copy.

HPS.Component CopyTo (HPS.Component in_new_owner)

Create a copy of this component under another component. This function will create a copy of the A3DEntity underlying this component and put it under the Exchange entity associated with the new owner. It will also create a new component, the keys associated to it and include those keys under the new owner. You are required to sync the HPS model tree with the PRC structures after calling this via Reload.

See

Reload

Param in_new_owner

The component which will be the owner of the newly created component.

Return

The newly created component.

override void Dispose ()

IntPtr GetExchangeEntity ()

Gets the A3DEntity pointer corresponding to this ExchangeComponent.

Return

The A3DEntity pointer corresponding to this ExchangeComponent.

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.

HPS.Exchange.ReloadNotifier Reload ()

Asynchronously reloads this component. This will delete all underlying subcomponents and then reparse the underlying Exchange data. This function should be invoked on the Component corresponding to an entity which was edited or a Component above such a Component.

Return

A ReloadNotifier object that can be used to query the reload progress and status.

HPS.Exchange.ReloadNotifier Reload (HPS.Exchange.TessellationOptionsKit in_tessellation_options)

Asynchronously reloads this component. This will delete all underlying subcomponents and then reparse the underlying Exchange data. This function should be invoked on the Component corresponding to an entity which was edited or a Component above such a Component.

Param in_tessellation_options

The options to use to generate tessellations for new Components (if necessary).

Return

A ReloadNotifier object that can be used to query the reload progress and status.

HPS.Exchange.ReloadNotifier Reload (HPS.Exchange.TessellationOptionsKit in_tessellation_options, HPS.Exchange.TranslationOptionsKit in_translation_options)

Asynchronously reloads this component. This will delete all underlying subcomponents and then reparse the underlying Exchange data. This function should be invoked on the Component corresponding to an entity which was edited or a Component above such a Component.

Param in_tessellation_options

The options to use to generate tessellations for new Components (if necessary).

Param in_translation_options

The options to use for translation from Exchange BRep to Parasolid. This option only applies if a file was loaded via the ExchangeParasolid module and there are components underlying this component that need to be translated to Parasolid.

Return

A ReloadNotifier object that can be used to query the reload progress and status.

bool SetName (string in_new_name)

Rename this component in the PRC.

Param in_new_name

The new name of the A3DEntity.

Return

true if the name was set successfully, false otherwise.

bool SetTransform (HPS.MatrixKit in_transform)

Applies a transform to the underlying PRC data associated with this component, replacing any transform currently set on it. Only components of type ExchangeProductOccurrence, or components that have the type ExchangeRepresentationItemMask can have transforms applied to them. Additionally, SetTransform does not work on Exchange models which have a Drawing structure to them. This would include CATDrawing files and 2D DWG files loaded through Exchange. Any attempt to use this function on those models will produce a warning.

Param in_transform

The transform to apply to this component.

Return

true if transform was applied correctly, false otherwise.

void Tessellate (HPS.Exchange.TessellationOptionsKit in_options)

Re-tessellate the given Component with the provided options. Tessellation occurs at the representation item level in Exchange, so calling this function on Component objects below that level will have no effect. If this function is invoked on Component objects above that level, e.g., at the product occurrence level, all representation items underneath that Component will be re-tessellated with the provided options. Additionally, only components for which there is BRep data can the tessellation be regenerated.

Param in_options

The options to use to generate the new tessellation for this Component.

HPS.Exchange.TranslationNotifier Translate (HPS.Exchange.Units in_units, HPS.Exchange.TranslationOptionsKit in_translation_options)

Asynchronously translates this component into an array of Parasolid parts, using the options provided. A valid Parasolid session is required for this function to succeed. The component has to be a Representation Item for this function to succeed.

Param in_units

The units for the representation item

Param in_translation_options

Options used during the translation.

Return

A TranslationNotifier object that can be used to query the translation progress and status.

class Configuration : public HPS.Sprocket

The Configuration class is a user space object. It is a used to get configuration information for a CAD file.

Public Functions

Configuration ()

The default constructor creates an empty Configuration object.

Configuration (HPS.Exchange.Configuration in_configuration)

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

Param in_configuration

The source Configuration to copy.

Configuration (string in_name)

This constructor creates a Configuration with the given name and no subconfigurations.

Param in_name

UTF8-encoded string with the name for this Configuration.

Configuration (string in_name, HPS.Exchange.Configuration[] in_subconfigurations)

This constructor creates a Configuration with the given name and the given subconfigurations

Param in_name

UTF8-encoded string with the name for this Configuration.

Param in_subconfigurations

The subconfigurations for this Configuration.

override void Dispose ()

override bool Empty ()

Indicates whether this Configuration has any values set on it.

Return

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

bool Equals (HPS.Exchange.Configuration in_kit)

Check if the source Configuration is equivalent to this Configuration.

Param in_kit

The source Configuration to compare to this Configuration.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

string GetName ()

Gets the name for this Configuration.

Return

The name for this Configuration.

HPS.Exchange.Configuration[] GetSubconfigurations ()

Gets the subconfigurations for this Configuration.

Return

The subconfigurations for this Configuration.

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.Exchange.Configuration in_kit)

Copies the source Configuration into this Configuration.

Param in_kit

The source Configuration to copy.

void Show (out HPS.Exchange.Configuration out_kit)

Copies this Configuration into the given Configuration.

Param out_kit

The Configuration to populate with the contents of this Configuration.

Public Static Functions

bool operator!= (HPS.Exchange.Configuration a, HPS.Exchange.Configuration b)

bool operator== (HPS.Exchange.Configuration a, HPS.Exchange.Configuration b)

class Export3MFOptionsKit : public HPS.SprocketKit

The HPS.Exchange.Export3MFOptionsKit class is a user space object. It contains settings controlling how 3MF data is exported via the Exchange interface.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this Export3MFOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.Export3MFOptionsKit in_kit)

Check if the source Export3MFOptionsKit is equivalent to this Export3MFOptionsKit.

Param in_kit

The source Export3MFOptionsKit to compare to this Export3MFOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

Export3MFOptionsKit ()

The default constructor creates an empty Export3MFOptionsKit object.

Export3MFOptionsKit (HPS.Exchange.Export3MFOptionsKit in_kit)

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

Param in_kit

The source Export3MFOptionsKit to copy.

override int GetHashCode ()

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.Exchange.Export3MFOptionsKit in_kit)

Copies the source Export3MFOptionsKit into this Export3MFOptionsKit.

Param in_kit

The source Export3MFOptionsKit to copy.

HPS.Exchange.Export3MFOptionsKit SetAdditionalKeyPaths (HPS.KeyPath[] in_additional_key_paths)

Sets an array of key paths which will be exported in addition to the model. Use this setting to export Visualize geometry to 3MF.

Param in_additional_key_paths

The key paths to be exported.

Return

A reference to this Export3MFOptionsKit.

HPS.Exchange.Export3MFOptionsKit SetCopyright (string in_copyright)

Sets the copyright metadata.

Param in_copyright

The copyright metadata.

Return

A reference to this Export3MFOptionsKit.

HPS.Exchange.Export3MFOptionsKit SetCurrentTessellationRetention (bool in_state)

Sets whether to retain the current tessellation during export.

Param in_state

Whether to retain the current tessellation during export.

Return

A reference to this Export3MFOptionsKit.

HPS.Exchange.Export3MFOptionsKit SetCurrentTessellationRetention (bool in_state, HPS.Exchange.TessellationOptionsKit in_tessellation_kit)

Sets whether to retain the current tessellation during export.

Param in_state

Whether to retain the current tessellation during export.

Param in_tessellation_kit

The tessellation to use during export. Only used if in_state is false, or if no tessellation is present.

Return

A reference to this Export3MFOptionsKit.

HPS.Exchange.Export3MFOptionsKit SetDescription (string in_description)

Sets a description. This will be reported in the output file as metadata.

Param in_description

The description.

Return

A reference to this Export3MFOptionsKit .

HPS.Exchange.Export3MFOptionsKit SetLicenseTerms (string in_license)

Sets license terms metadata.

Param in_license

The license terms metadata.

Return

A reference to this Export3MFOptionsKit.

void Show (out HPS.Exchange.Export3MFOptionsKit out_kit)

Copies this Export3MFOptionsKit into the given Export3MFOptionsKit.

Param out_kit

The Export3MFOptionsKit to populate with the contents of this Export3MFOptionsKit.

bool ShowAdditionalKeyPaths (out HPS.KeyPath[] out_additional_key_paths)

Shows the additional key paths setting.

Param out_additional_key_paths

The key paths which will be added to the model

Return

true if an additional key paths setting was specified, false otherwise.

bool ShowCopyright (out string out_copyright)

Shows the copyright setting.

Param out_copyright

The copyright metadata.

Return

true if a copyright setting was specified, false otherwise.

bool ShowCurrentTessellationRetention (out bool out_state, out HPS.Exchange.TessellationOptionsKit out_tessellation_kit)

Shows the KeepCurrentTessellation setting.

Param out_state

Whether to retain the current tessellation during export.

Param out_tessellation_kit

The tessellation options to use during export. Only valid if out_state is false.

Return

true if a tessellation retention setting was specified, false otherwise.

bool ShowDescription (out string out_description)

Shows the description setting.

Param out_description

The description.

Return

true if a description setting was specified, false otherwise.

bool ShowLicenseTerms (out string out_license)

Shows the license setting.

Param out_license

The license metadata

Return

true if a license setting was specified, false otherwise.

HPS.Exchange.Export3MFOptionsKit UnsetAdditionalKeyPaths ()

Removes the additional key paths setting.

Return

A reference to this Export3MFOptionsKit.

HPS.Exchange.Export3MFOptionsKit UnsetCopyright ()

Removes the Copyright setting.

Return

A reference to this Export3MFOptionsKit.

HPS.Exchange.Export3MFOptionsKit UnsetCurrentTessellationRetention ()

Removes the KeepCurrentTessellation setting.

Return

A reference to this Export3MFOptionsKit.

HPS.Exchange.Export3MFOptionsKit UnsetDescription ()

Removes the description setting.

Return

A reference to this Export3MFOptionsKit.

HPS.Exchange.Export3MFOptionsKit UnsetEverything ()

Removes all settings from this Export3MFOptionsKit.

Return

A reference to this Export3MFOptionsKit.

HPS.Exchange.Export3MFOptionsKit UnsetLicenseTerms ()

Removes the license setting.

Return

A reference to this Export3MFOptionsKit.

Public Static Functions

HPS.Exchange.Export3MFOptionsKit GetDefault ()

Creates an Export3MFOptionsKit 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 defaults. These values will be used for export unless an option in overridden by the options passed to File.Export3MF.

Return

An Export3MFOptionsKit with the default settings.

bool operator!= (HPS.Exchange.Export3MFOptionsKit a, HPS.Exchange.Export3MFOptionsKit b)

bool operator== (HPS.Exchange.Export3MFOptionsKit a, HPS.Exchange.Export3MFOptionsKit b)

class ExportACISOptionsKit : public HPS.SprocketKit

The HPS.Exchange.ExportACISOptionsKit class is a user space object. It contains settings controlling how ACIS data is exported via the Exchange interface. Calling HPS.Exchange.ExportACISOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportACISOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportACISOptionsKit in_kit)

Check if the source ExportACISOptionsKit is equivalent to this ExportACISOptionsKit.

Param in_kit

The source ExportACISOptionsKit to compare to this ExportACISOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportACISOptionsKit ()

The default constructor creates an empty ExportACISOptionsKit object.

ExportACISOptionsKit (HPS.Exchange.ExportACISOptionsKit in_kit)

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

Param in_kit

The source ExportACISOptionsKit to copy.

override int GetHashCode ()

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.Exchange.ExportACISOptionsKit in_kit)

Copies the source ExportACISOptionsKit into this ExportACISOptionsKit.

Param in_kit

The source ExportACISOptionsKit to copy.

HPS.Exchange.ExportACISOptionsKit SetBinary (bool in_state)

Sets whether to write ACIS data in binary form. This corresponds to the value that will be passed to A3DRWParamsExportAcisData::m_bSaveAsBinary.

See

Default value

Param in_state

Whether to write ACIS data in binary form.

Return

A reference to this ExportACISOptionsKit.

HPS.Exchange.ExportACISOptionsKit SetMillimeterUnits (bool in_state)

Sets whether to write ACIS data in millimeter units instead of the native units of the CADModel. This corresponds to the value that will be passed to A3DRWParamsExportAcisData::m_bSaveAsMillimeter.

See

Default value

Param in_state

Whether to write ACIS data in millimeter units instead of the native units of the CADModel.

Return

A reference to this ExportACISOptionsKit.

void Show (out HPS.Exchange.ExportACISOptionsKit out_kit)

Copies this ExportACISOptionsKit into the given ExportACISOptionsKit.

Param out_kit

The ExportACISOptionsKit to populate with the contents of this ExportACISOptionsKit.

bool ShowBinary (out bool out_state)

Shows the binary export setting.

Param out_state

Whether to write ACIS data in binary form.

Return

true if a binary export setting was specified, false otherwise.

bool ShowMillimeterUnits (out bool out_state)

Shows the millimeter unit export setting.

Param out_state

Whether to write ACIS data in millimeter units instead of the native units of the CADModel.

Return

true if a millimeter unit export setting was specified, false otherwise.

HPS.Exchange.ExportACISOptionsKit UnsetBinary ()

Removes the binary export setting.

Return

A reference to this ExportACISOptionsKit.

HPS.Exchange.ExportACISOptionsKit UnsetEverything ()

Removes all settings from this ExportACISOptionsKit.

Return

A reference to this ExportACISOptionsKit.

HPS.Exchange.ExportACISOptionsKit UnsetMillimeterUnits ()

Removes the millimeter unit export setting.

Return

A reference to this ExportACISOptionsKit.

Public Static Functions

HPS.Exchange.ExportACISOptionsKit GetDefault ()

Creates an ExportACISOptionsKit 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.ExportACIS.

Return

An ExportACISOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ExportACISOptionsKit a, HPS.Exchange.ExportACISOptionsKit b)

bool operator== (HPS.Exchange.ExportACISOptionsKit a, HPS.Exchange.ExportACISOptionsKit b)

class ExportFBXOptionsKit : public HPS.SprocketKit

The HPS.Exchange.ExportFBXOptionsKit class is a user space object. It contains settings controlling how FBX data is exported via the Exchange interface. Calling HPS.Exchange.ExportFBXOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportFBXOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportFBXOptionsKit in_kit)

Check if the source ExportFBXOptionsKit is equivalent to this ExportFBXOptionsKit.

Param in_kit

The source ExportFBXOptionsKit to compare to this ExportFBXOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportFBXOptionsKit ()

The default constructor creates an empty ExportFBXOptionsKit object.

ExportFBXOptionsKit (HPS.Exchange.ExportFBXOptionsKit in_kit)

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

Param in_kit

The source ExportFBXOptionsKit to copy.

override int GetHashCode ()

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.Exchange.ExportFBXOptionsKit in_kit)

Copies the source ExportFBXOptionsKit into this ExportFBXOptionsKit.

Param in_kit

The source ExportFBXOptionsKit to copy.

HPS.Exchange.ExportFBXOptionsKit SetAscii (bool in_state)

Sets whether to write FBX data in ascii form. This corresponds to the value that will be passed to A3DRWParamsExportFBXData::m_bAscii.

See

Default value

Param in_state

Whether to write FBX data in ascii form.

Return

A reference to this ExportFBXOptionsKit.

HPS.Exchange.ExportFBXOptionsKit SetTextureFolder (string in_name)

Sets folder where texture will be exported (if any). If NULL, then texture are written in the same directory as the .fbx. Symbol @ is expanded as Filename of current file (without extension) Example: If the output file is ‘C:/out/myfile.obj’ and the texture folder is set to ‘C:/out/myfile.obj’, the export process will create a directory called ‘C:/out/myfile’ and place the textures there

See

Default value

Param in_name

UTF8-encoded path to the folder where texture will be exported. This corresponds to the value that will be passed to and A3DRWParamsExportFbxData::m_pcTextureFolder.

Return

A reference to this ExportFBXOptionsKit.

void Show (out HPS.Exchange.ExportFBXOptionsKit out_kit)

Copies this ExportFBXOptionsKit into the given ExportFBXOptionsKit.

Param out_kit

The ExportFBXOptionsKit to populate with the contents of this ExportFBXOptionsKit.

bool ShowAscii (out bool out_state)

Shows the ascii export setting.

Param out_state

Whether to write FBX data in ascii form.

Return

true if a ascii export setting was specified, false otherwise.

bool ShowTextureFolder (out string out_path)

Shows the texture folder setting.

Param out_path

The path to the folder where texture will be exported.

Return

true if a texture folder setting was specified, false otherwise.

HPS.Exchange.ExportFBXOptionsKit UnsetAscii ()

Removes the ascii export setting.

Return

A reference to this ExportFBXOptionsKit.

HPS.Exchange.ExportFBXOptionsKit UnsetEverything ()

Removes all settings from this ExportFBXOptionsKit.

Return

A reference to this ExportFBXOptionsKit.

HPS.Exchange.ExportFBXOptionsKit UnsetTextureFolder ()

Removes the texture folder setting.

Return

A reference to this ExportFBXOptionsKit.

Public Static Functions

HPS.Exchange.ExportFBXOptionsKit GetDefault ()

Creates an ExportFBXOptionsKit 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.ExportFBX.

Return

An ExportFBXOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ExportFBXOptionsKit a, HPS.Exchange.ExportFBXOptionsKit b)

bool operator== (HPS.Exchange.ExportFBXOptionsKit a, HPS.Exchange.ExportFBXOptionsKit b)

class ExportGLTFOptionsKit : public HPS.SprocketKit

The HPS.Exchange.ExportGLTFOptionsKit class is a user space object. It contains settings controlling how GLTF data is exported via the Exchange interface. Calling HPS.Exchange.ExportGLTFOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportGLTFOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportGLTFOptionsKit in_kit)

Check if the source ExportGLTFOptionsKit is equivalent to this ExportGLTFOptionsKit.

Param in_kit

The source ExportGLTFOptionsKit to compare to this ExportGLTFOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportGLTFOptionsKit ()

The default constructor creates an empty ExportGLTFOptionsKit object.

ExportGLTFOptionsKit (HPS.Exchange.ExportGLTFOptionsKit in_kit)

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

Param in_kit

The source ExportGLTFOptionsKit to copy.

override int GetHashCode ()

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.Exchange.ExportGLTFOptionsKit in_kit)

Copies the source ExportGLTFOptionsKit into this ExportGLTFOptionsKit.

Param in_kit

The source ExportGLTFOptionsKit to copy.

HPS.Exchange.ExportGLTFOptionsKit SetAscii (bool in_state)

Sets whether to write GLTF data in ascii form. This corresponds to the value that will be passed to A3DRWParamsExportGLTFData::m_bAscii.

See

Default value

Param in_state

Whether to write GLTF data in ascii form.

Return

A reference to this ExportGLTFOptionsKit.

HPS.Exchange.ExportGLTFOptionsKit SetTextureFolder (string in_name)

Sets folder where texture will be exported (if any). If NULL, then texture are written in the same directory as the .fbx. Symbol @ is expanded as Filename of current file (without extension) Example: If the output file is ‘C:/out/myfile.obj’ and the texture folder is set to ‘C:/out/myfile.obj’, the export process will create a directory called ‘C:/out/myfile’ and place the textures there

See

Default value

Param in_name

UTF8-encoded path to the folder where texture will be exported. This corresponds to the value that will be passed to and A3DRWParamsExportFbxData::m_pcTextureFolder.

Return

A reference to this ExportGLTFOptionsKit.

void Show (out HPS.Exchange.ExportGLTFOptionsKit out_kit)

Copies this ExportGLTFOptionsKit into the given ExportGLTFOptionsKit.

Param out_kit

The ExportGLTFOptionsKit to populate with the contents of this ExportGLTFOptionsKit.

bool ShowAscii (out bool out_state)

Shows the ascii export setting.

Param out_state

Whether to write GLTF data in ascii form.

Return

true if a ascii export setting was specified, false otherwise.

bool ShowTextureFolder (out string out_path)

Shows the texture folder setting.

Param out_path

The path to the folder where texture will be exported.

Return

true if a texture folder setting was specified, false otherwise.

HPS.Exchange.ExportGLTFOptionsKit UnsetAscii ()

Removes the ascii export setting.

Return

A reference to this ExportGLTFOptionsKit.

HPS.Exchange.ExportGLTFOptionsKit UnsetEverything ()

Removes all settings from this ExportGLTFOptionsKit.

Return

A reference to this ExportGLTFOptionsKit.

HPS.Exchange.ExportGLTFOptionsKit UnsetTextureFolder ()

Removes the texture folder setting.

Return

A reference to this ExportGLTFOptionsKit.

Public Static Functions

HPS.Exchange.ExportGLTFOptionsKit GetDefault ()

Creates an ExportGLTFOptionsKit 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.ExportGLTF.

Return

An ExportGLTFOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ExportGLTFOptionsKit a, HPS.Exchange.ExportGLTFOptionsKit b)

bool operator== (HPS.Exchange.ExportGLTFOptionsKit a, HPS.Exchange.ExportGLTFOptionsKit b)

class ExportIGESOptionsKit : public HPS.SprocketKit

The HPS.Exchange.ExportIGESOptionsKit class is a user space object. It contains settings controlling how IGES data is exported via Exchange. Calling HPS.Exchange.ExportIGESOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportIGESOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportIGESOptionsKit in_kit)

Check if the source ExportIGESOptionsKit is equivalent to this ExportIGESOptionsKit.

Param in_kit

The source ExportIGESOptionsKit to compare to this ExportIGESOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportIGESOptionsKit ()

The default constructor creates an empty ExportIGESOptionsKit object.

ExportIGESOptionsKit (HPS.Exchange.ExportIGESOptionsKit in_kit)

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

Param in_kit

The source ExportIGESOptionsKit to copy.

override int GetHashCode ()

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.Exchange.ExportIGESOptionsKit in_kit)

Copies the source ExportIGESOptionsKit into this ExportIGESOptionsKit.

Param in_kit

The source ExportIGESOptionsKit to copy.

HPS.Exchange.ExportIGESOptionsKit SetAnalyticsAsNURBS (bool in_state)

Sets whether to convert analytic surfaces (planes, cones, cylinder, etc.) to NURBS surfaces for export. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveAnalyticsToNurbs.

See

Default value

Param in_state

Whether to convert analytic surfaces to NURBS surfaces for export.

Return

A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit SetApplication (string in_name)

Sets the application name to put in the IGES data. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_pcApplication.

Param in_name

UTF8-encoded application name to put in the IGES data.

Return

A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit SetFacetedAsWireframe (bool in_state)

Sets whether to convert polyhedrics to wireframe data for export. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveFacetedToWireframe.

See

Default value

Param in_state

Whether to convert polyhedrics to wireframe data for export.

Return

A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit SetHiddenObjects (bool in_state)

Sets whether to export hidden objects. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bWriteHiddenObjects.

See

Default value

Param in_state

Whether to export hidden objects.

Return

A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit SetSolidsAsFaces (bool in_state)

Sets whether to convert solids to a set of independent faces for export. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveSolidsAsFaces.

See

Default value

Param in_state

Whether to convert solids to a set of independent faces for export.

Return

A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit SetTessellation (bool in_state)

Sets whether to export tessellation data. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bWriteTessellation.

See

Default value

Param in_state

Whether to export tessellation data.

Return

A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit SetVersion (string in_version)

Sets the version string to put in the IGES data. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_pcVersion.

Param in_version

UTF8-encoded version string to put in the IGES data.

Return

A reference to this ExportIGESOptionsKit.

void Show (out HPS.Exchange.ExportIGESOptionsKit out_kit)

Copies this ExportIGESOptionsKit into the given ExportIGESOptionsKit.

Param out_kit

The ExportIGESOptionsKit to populate with the contents of this ExportIGESOptionsKit.

bool ShowAnalyticsAsNURBS (out bool out_state)

Shows the analytics to NURBS conversion setting.

Param out_state

Whether to convert analytic surfaces to NURBS surfaces for export.

Return

true if an analytics to NURBS conversion setting was specified, false otherwise.

bool ShowApplication (out string out_name)

Shows the application name setting.

Param out_name

The application name to put in the IGES data.

Return

true if an application name setting was specified, false otherwise.

bool ShowFacetedAsWireframe (out bool out_state)

Shows the faceted to wireframe conversion setting.

Param out_state

Whether to convert polyhedrics to wireframe data for export.

Return

true if a faceted to wireframe conversion setting was specified, false otherwise.

bool ShowHiddenObjects (out bool out_state)

Shows the hidden object export setting.

Param out_state

Whether to export hidden objects.

Return

true if a hidden object export setting was specified, false otherwise.

bool ShowSolidsAsFaces (out bool out_state)

Shows the solids to faces conversion setting.

Param out_state

Whether to convert solids to a set of independent faces for export.

Return

true if a solids to faces conversion setting was specified, false otherwise.

bool ShowTessellation (out bool out_state)

Shows the tessellation export setting.

Param out_state

Whether to export tessellation data.

Return

true if a tessellation export setting was specified, false otherwise.

bool ShowVersion (out string out_version)

Shows the version string setting.

Param out_version

The version string to put in the IGES data.

Return

true if a version string setting was specified, false otherwise.

HPS.Exchange.ExportIGESOptionsKit UnsetAnalyticsAsNURBS ()

Removes the analytics to NURBS conversion setting.

Return

A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit UnsetApplication ()

Removes the application name setting.

Return

A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit UnsetEverything ()

Removes all settings from this ExportIGESOptionsKit.

Return

A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit UnsetFacetedAsWireframe ()

Removes the faceted to wireframe conversion setting.

Return

A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit UnsetHiddenObjects ()

Removes the hidden objects export setting.

Return

A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit UnsetSolidsAsFaces ()

Removes the solids to faces conversion setting.

Return

A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit UnsetTessellation ()

Removes the tessellation export setting.

Return

A reference to this ExportIGESOptionsKit.

HPS.Exchange.ExportIGESOptionsKit UnsetVersion ()

Removes the version string setting.

Return

A reference to this ExportIGESOptionsKit.

Public Static Functions

HPS.Exchange.ExportIGESOptionsKit GetDefault ()

Creates an ExportIGESOptionsKit 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.ExportIGES.

Return

An ExportIGESOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ExportIGESOptionsKit a, HPS.Exchange.ExportIGESOptionsKit b)

bool operator== (HPS.Exchange.ExportIGESOptionsKit a, HPS.Exchange.ExportIGESOptionsKit b)

class ExportJTOptionsKit : public HPS.SprocketKit

The HPS.Exchange.ExportJTOptionsKit class is a user space object. It contains settings controlling how JT data is exported via Exchange. Calling HPS.Exchange.ExportJTOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportJTOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportJTOptionsKit in_kit)

Check if the source ExportJTOptionsKit is equivalent to this ExportJTOptionsKit.

Param in_kit

The source ExportJTOptionsKit to compare to this ExportJTOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportJTOptionsKit ()

The default constructor creates an empty ExportJTOptionsKit object.

ExportJTOptionsKit (HPS.Exchange.ExportJTOptionsKit in_kit)

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

Param in_kit

The source ExportJTOptionsKit to copy.

override int GetHashCode ()

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.Exchange.ExportJTOptionsKit in_kit)

Copies the source ExportJTOptionsKit into this ExportJTOptionsKit.

Param in_kit

The source ExportJTOptionsKit to copy.

HPS.Exchange.ExportJTOptionsKit SetContent (HPS.Exchange.JT.Content in_content)

Sets the type of data to export. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_eWriteGeomTessMode.

See

Default value

Param in_content

The type of data to export.

Return

A reference to this ExportJTOptionsKit.

HPS.Exchange.ExportJTOptionsKit SetHiddenObjects (bool in_state)

Sets whether to export hidden objects. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_bWriteHiddenObjects.

See

Default value

Param in_state

Whether to export hidden objects.

Return

A reference to this ExportJTOptionsKit.

HPS.Exchange.ExportJTOptionsKit SetPMI (bool in_state)

Sets whether to export PMI. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_bWritePMI.

See

Default value

Param in_state

Whether to export PMI.

Return

A reference to this ExportJTOptionsKit.

HPS.Exchange.ExportJTOptionsKit SetVersion (HPS.Exchange.JT.Version in_version)

Sets the version of the JT format to export. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_eJTVersion.

See

Default value

Param in_version

The version of the JT format to export.

Return

A reference to this ExportJTOptionsKit.

void Show (out HPS.Exchange.ExportJTOptionsKit out_kit)

Copies this ExportJTOptionsKit into the given ExportJTOptionsKit.

Param out_kit

The ExportJTOptionsKit to populate with the contents of this ExportJTOptionsKit.

bool ShowContent (out HPS.Exchange.JT.Content out_content)

Shows the content export setting.

Param out_content

The type of data to export.

Return

true if a content export setting was specified, false otherwise.

bool ShowHiddenObjects (out bool out_state)

Shows the hidden object export setting.

Param out_state

Whether to export hidden objects.

Return

true if a hidden object export setting was specified, false otherwise.

bool ShowPMI (out bool out_state)

Shows the PMI export setting.

Param out_state

Whether to export PMI.

Return

true if a PMI export setting was specified, false otherwise.

bool ShowVersion (out HPS.Exchange.JT.Version out_version)

Shows the version export setting.

Param out_version

The version of the JT format to export.

Return

true if a version export setting was specified, false otherwise.

HPS.Exchange.ExportJTOptionsKit UnsetContent ()

Removes the content export setting.

Return

A reference to this ExportJTOptionsKit.

HPS.Exchange.ExportJTOptionsKit UnsetEverything ()

Removes all settings from this ExportJTOptionsKit.

Return

A reference to this ExportJTOptionsKit.

HPS.Exchange.ExportJTOptionsKit UnsetHiddenObjects ()

Removes the hidden objects export setting.

Return

A reference to this ExportJTOptionsKit.

HPS.Exchange.ExportJTOptionsKit UnsetPMI ()

Removes the PMI export setting.

Return

A reference to this ExportJTOptionsKit.

HPS.Exchange.ExportJTOptionsKit UnsetVersion ()

Removes the version export setting.

Return

A reference to this ExportJTOptionsKit.

Public Static Functions

HPS.Exchange.ExportJTOptionsKit GetDefault ()

Creates an ExportJTOptionsKit 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.ExportJT.

Return

An ExportJTOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ExportJTOptionsKit a, HPS.Exchange.ExportJTOptionsKit b)

bool operator== (HPS.Exchange.ExportJTOptionsKit a, HPS.Exchange.ExportJTOptionsKit b)

class ExportNotifier : public HPS.IONotifier

The ExportNotifier class is a smart-pointer that is tied to a file export. It is used to interact with an ongoing export or get the results from a completed export.

Public Functions

void Assign (HPS.Exchange.ExportNotifier in_that)

Associate this ExportNotifier with the same file export as the source ExportNotifier.

Param in_that

The source ExportNotifier for the assignment.

override void Dispose ()

ExportNotifier ()

The default constructor creates an ExportNotifier object which is not tied to any file export.

ExportNotifier (HPS.Exchange.ExportNotifier in_that)

The copy constructor creates a new ExportNotifier object that is associated with the same file export as the source ExportNotifier.

Param in_that

The source ExportNotifier to copy.

ExportNotifier (HPS.IONotifier in_that)

The conversion constructor creates a new derived ExportNotifier object from a base IONotifier object. The copy will only be successful if the source notifier is really an upcast of this notifier type. Otherwise the copy will fail and the resulting ExportNotifier will be invalid.

Param in_that

The source IONotifier to copy.

IntPtr GetModelFile ()

Get the A3DAsmModelFile created during the export. Throws an IOException if the export is not complete, was not successful or was canceled. It will be up to the user to delete this A3DAsmModelFile via A3DAsmModelFileDelete.

Return

The A3DAsmModelFile for a successful file export.

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.

class ExportOBJOptionsKit : public HPS.SprocketKit

The HPS.Exchange.ExportOBJOptionsKit class is a user space object. It contains settings controlling how OBJ data is exported via Exchange. Calling HPS.Exchange.ExportOBJOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportOBJOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportOBJOptionsKit in_kit)

Check if the source ExportOBJOptionsKit is equivalent to this ExportOBJOptionsKit.

Param in_kit

The source ExportOBJOptionsKit to compare to this ExportOBJOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportOBJOptionsKit ()

The default constructor creates an empty ExportOBJOptionsKit object.

ExportOBJOptionsKit (HPS.Exchange.ExportOBJOptionsKit in_kit)

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

Param in_kit

The source ExportOBJOptionsKit to copy.

override int GetHashCode ()

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.Exchange.ExportOBJOptionsKit in_kit)

Copies the source ExportOBJOptionsKit into this ExportOBJOptionsKit.

Param in_kit

The source ExportOBJOptionsKit to copy.

HPS.Exchange.ExportOBJOptionsKit SetTextureFolder (string in_name)

Sets folder where texture will be exported (if any). If NULL, then texture are written in the same directory as the .fbx. Symbol @ is expanded as Filename of current file (without extension)

Param in_name

UTF8-encoded path to the folder where texture will be exported. This corresponds to the value that will be passed to and A3DRWParamsExportObjData::m_pcTextureFolder.

Return

A reference to this ExportOBJOptionsKit.

void Show (out HPS.Exchange.ExportOBJOptionsKit out_kit)

Copies this ExportOBJOptionsKit into the given ExportOBJOptionsKit.

Param out_kit

The ExportOBJOptionsKit to populate with the contents of this ExportOBJOptionsKit.

bool ShowTextureFolder (out string out_path)

Shows the texture folder setting.

Param out_path

The path to the folder where texture will be exported.

Return

true if a texture folder setting was specified, false otherwise.

HPS.Exchange.ExportOBJOptionsKit UnsetEverything ()

Removes all settings from this ExportOBJOptionsKit.

Return

A reference to this ExportOBJOptionsKit.

HPS.Exchange.ExportOBJOptionsKit UnsetTextureFolder ()

Removes the texture folder setting.

Return

A reference to this ExportOBJOptionsKit.

Public Static Functions

HPS.Exchange.ExportOBJOptionsKit GetDefault ()

Creates an ExportOBJOptionsKit 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.ExportOBJ.

Return

An ExportOBJOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ExportOBJOptionsKit a, HPS.Exchange.ExportOBJOptionsKit b)

bool operator== (HPS.Exchange.ExportOBJOptionsKit a, HPS.Exchange.ExportOBJOptionsKit b)

class ExportParasolidOptionsKit : public HPS.SprocketKit

The HPS.Exchange.ExportParasolidOptionsKit class is a user space object. It contains settings controlling how Parasolid data is exported via Exchange. Calling HPS.Exchange.ExportParasolidOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportParasolidOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportParasolidOptionsKit in_kit)

Check if the source ExportParasolidOptionsKit is equivalent to this ExportParasolidOptionsKit.

Param in_kit

The source ExportParasolidOptionsKit to compare to this ExportParasolidOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportParasolidOptionsKit ()

The default constructor creates an empty ExportParasolidOptionsKit object.

ExportParasolidOptionsKit (HPS.Exchange.ExportParasolidOptionsKit in_kit)

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

Param in_kit

The source ExportParasolidOptionsKit to copy.

override int GetHashCode ()

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.Exchange.ExportParasolidOptionsKit in_kit)

Copies the source ExportParasolidOptionsKit into this ExportParasolidOptionsKit.

Param in_kit

The source ExportParasolidOptionsKit to copy.

HPS.Exchange.ExportParasolidOptionsKit SetApplication (string in_name)

Sets the application name to put in the Parasolid data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_pcApplication.

Param in_name

UTF8-encoded application name to put in the Parasolid data.

Return

A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit SetExplodeMultiBodies (bool in_state)

Sets whether to explode multi-connexes B-reps into multiple bodies. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bExplodeMultiBodies.

See

Default value

Param in_state

Whether to explode multi-connexes B-reps into multiple bodies.

Return

A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit SetHiddenObjects (bool in_state)

Sets whether to export hidden objects. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bWriteBlankedEntities.

See

Default value

Param in_state

Whether to export hidden objects.

Return

A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit SetSolidsAsFaces (bool in_state)

Sets whether to convert solids to a set of independent faces for export. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveSolidsAsFaces.

See

Default value

Param in_state

Whether to convert solids to a set of independent faces for export.

Return

A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit SetTessellation (bool in_state)

Sets whether to export tessellation data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bWriteTessellation.

See

Default value

Param in_state

Whether to export tessellation data.

Return

A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit SetVersion (string in_version)

Sets the version string to put in the Parasolid data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_pcVersion.

Param in_version

UTF8-encoded version string to put in the Parasolid data.

Return

A reference to this ExportParasolidOptionsKit.

void Show (out HPS.Exchange.ExportParasolidOptionsKit out_kit)

Copies this ExportParasolidOptionsKit into the given ExportParasolidOptionsKit.

Param out_kit

The ExportParasolidOptionsKit to populate with the contents of this ExportParasolidOptionsKit.

bool ShowApplication (out string out_name)

Shows the application name setting.

Param out_name

The application name to put in the Parasolid data.

Return

true if an application name setting was specified, false otherwise.

bool ShowExplodeMultiBodies (out bool out_state)

Shows the explode multi bodies setting.

Param out_state

The explode multi bodies setting to put in the Parasolid data.

Return

true if a explode multi bodies setting was specified, false otherwise.

bool ShowHiddenObjects (out bool out_state)

Shows the hidden object export setting.

Param out_state

Whether to export hidden objects.

Return

true if a hidden object export setting was specified, false otherwise.

bool ShowSolidsAsFaces (out bool out_state)

Shows the solids to faces conversion setting.

Param out_state

Whether to convert solids to a set of independent faces for export.

Return

true if a solids to faces conversion setting was specified, false otherwise.

bool ShowTessellation (out bool out_state)

Shows the tessellation export setting.

Param out_state

Whether to export tessellation data.

Return

true if a tessellation export setting was specified, false otherwise.

bool ShowVersion (out string out_version)

Shows the version string setting.

Param out_version

The version string to put in the Parasolid data.

Return

true if a version string setting was specified, false otherwise.

HPS.Exchange.ExportParasolidOptionsKit UnsetApplication ()

Removes the application name setting.

Return

A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit UnsetEverything ()

Removes all settings from this ExportParasolidOptionsKit.

Return

A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit UnsetExplodeMultiBodies ()

Removes the explode multi bodies setting.

Return

A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit UnsetHiddenObjects ()

Removes the hidden objects export setting.

Return

A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit UnsetSolidsAsFaces ()

Removes the solids to faces conversion setting.

Return

A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit UnsetTessellation ()

Removes the tessellation export setting.

Return

A reference to this ExportParasolidOptionsKit.

HPS.Exchange.ExportParasolidOptionsKit UnsetVersion ()

Removes the version string setting.

Return

A reference to this ExportParasolidOptionsKit.

Public Static Functions

HPS.Exchange.ExportParasolidOptionsKit GetDefault ()

Creates an ExportParasolidOptionsKit 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.ExportParasolid.

Return

An ExportParasolidOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ExportParasolidOptionsKit a, HPS.Exchange.ExportParasolidOptionsKit b)

bool operator== (HPS.Exchange.ExportParasolidOptionsKit a, HPS.Exchange.ExportParasolidOptionsKit b)

class ExportPRCOptionsKit : public HPS.SprocketKit

The HPS.Exchange.ExportPRCOptionsKit class is a user space object. It contains settings controlling how PRC data is exported via Exchange. Calling HPS.Exchange.ExportPRCOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportPRCOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportPRCOptionsKit in_kit)

Check if the source ExportPRCOptionsKit is equivalent to this ExportPRCOptionsKit.

Param in_kit

The source ExportPRCOptionsKit to compare to this ExportPRCOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportPRCOptionsKit ()

The default constructor creates an empty ExportPRCOptionsKit object.

ExportPRCOptionsKit (HPS.Exchange.ExportPRCOptionsKit in_kit)

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

Param in_kit

The source ExportPRCOptionsKit to copy.

override int GetHashCode ()

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.Exchange.ExportPRCOptionsKit in_kit)

Copies the source ExportPRCOptionsKit into this ExportPRCOptionsKit.

Param in_kit

The source ExportPRCOptionsKit to copy.

HPS.Exchange.ExportPRCOptionsKit SetAdditionalKeyPaths (HPS.KeyPath[] in_additional_key_paths)

Sets an array of key paths which will be exported to PRC in addition to the model. Use this setting to export Visualize geometry to PRC.

Param in_additional_key_paths

The key paths to be exported.

Return

A reference to this AnnotationKit.

HPS.Exchange.ExportPRCOptionsKit SetAttributeRemoval (bool in_state)

Sets whether to remove the attribute information for export. This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bRemoveAttributes.

See

Default value

Param in_state

Whether to remove the attribute information in the PRC data for this annotation.

Return

A reference to this AnnotationKit.

HPS.Exchange.ExportPRCOptionsKit SetBRepCompression (HPS.Exchange.PRC.BRepCompression in_level)

Sets the level of compression to apply to BRep data for export. This corresponds to the values that will be passed to A3DRWParamsExportPrcData::m_bCompressBrep and A3DRWParamsExportPrcData::m_eCompressBrepType.

See

Default value

Param in_level

The level of compression to apply to BRep data for export.

Return

A reference to this ExportPRCOptionsKit.

HPS.Exchange.ExportPRCOptionsKit SetBRepRemoval (bool in_state)

Sets whether to remove the BRep information for export. This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bRemoveBRep.

See

Default value

Param in_state

Whether to remove BRep information in the PRC data for this annotation.

Return

A reference to this AnnotationKit.

HPS.Exchange.ExportPRCOptionsKit SetTessellationCompression (bool in_state)

Sets whether to compress tessellation for export. This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bCompressTessellation.

See

Default value

Param in_state

Whether to compress tessellation for export.

Return

A reference to this ExportPRCOptionsKit.

void Show (out HPS.Exchange.ExportPRCOptionsKit out_kit)

Copies this ExportPRCOptionsKit into the given ExportPRCOptionsKit.

Param out_kit

The ExportPRCOptionsKit to populate with the contents of this ExportPRCOptionsKit.

bool ShowAdditionalKeyPaths (out HPS.KeyPath[] out_additional_key_paths)

Shows the additional key paths setting.

Param out_additional_key_paths

The key paths which will be added to the model

Return

true if an additional key paths setting was specified, false otherwise.

bool ShowAttributeRemoval (out bool out_state)

Shows the attribute removal setting.

Param out_state

Whether to remove attribute information for export.

Return

true if an attribute removal setting was specified, false otherwise.

bool ShowBRepCompression (out HPS.Exchange.PRC.BRepCompression out_level)

Shows the BRep compression level setting.

Param out_level

The level of compression to apply to BRep data for export.

Return

true if a BRep compression level setting was specified, false otherwise.

bool ShowBRepRemoval (out bool out_state)

Shows the BRep removal setting.

Param out_state

Whether to remove BRep information for export.

Return

true if a BRep removal setting was specified, false otherwise.

bool ShowTessellationCompression (out bool out_state)

Shows the tessellation compression setting.

Param out_state

Whether to compress tessellation for export.

Return

true if a tessellation compression setting was specified, false otherwise.

HPS.Exchange.ExportPRCOptionsKit UnsetAdditionalKeyPaths ()

Removes the additional key paths setting.

Return

A reference to this ExportPRCOptionsKit.

HPS.Exchange.ExportPRCOptionsKit UnsetAttributeRemoval ()

Removes the attribute removal setting.

Return

A reference to this ExportPRCOptionsKit.

HPS.Exchange.ExportPRCOptionsKit UnsetBRepCompression ()

Removes the BRep compression level setting.

Return

A reference to this ExportPRCOptionsKit.

HPS.Exchange.ExportPRCOptionsKit UnsetBRepRemoval ()

Removes the BRep removal setting.

Return

A reference to this ExportPRCOptionsKit.

HPS.Exchange.ExportPRCOptionsKit UnsetEverything ()

Removes all settings from this ExportPRCOptionsKit.

Return

A reference to this ExportPRCOptionsKit.

HPS.Exchange.ExportPRCOptionsKit UnsetTessellationCompression ()

Removes the tessellation compression setting.

Return

A reference to this ExportPRCOptionsKit.

Public Static Functions

HPS.Exchange.ExportPRCOptionsKit GetDefault ()

Creates an ExportPRCOptionsKit 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.ExportPRC.

Return

An ExportPRCOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ExportPRCOptionsKit a, HPS.Exchange.ExportPRCOptionsKit b)

bool operator== (HPS.Exchange.ExportPRCOptionsKit a, HPS.Exchange.ExportPRCOptionsKit b)

class ExportSTEPOptionsKit : public HPS.SprocketKit

The HPS.Exchange.ExportSTEPOptionsKit class is a user space object. It contains settings controlling how STEP data is exported via Exchange. Calling HPS.Exchange.ExportSTEPOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportSTEPOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportSTEPOptionsKit in_kit)

Check if the source ExportSTEPOptionsKit is equivalent to this ExportSTEPOptionsKit.

Param in_kit

The source ExportSTEPOptionsKit to compare to this ExportSTEPOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportSTEPOptionsKit ()

The default constructor creates an empty ExportSTEPOptionsKit object.

ExportSTEPOptionsKit (HPS.Exchange.ExportSTEPOptionsKit in_kit)

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

Param in_kit

The source ExportSTEPOptionsKit to copy.

override int GetHashCode ()

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.Exchange.ExportSTEPOptionsKit in_kit)

Copies the source ExportSTEPOptionsKit into this ExportSTEPOptionsKit.

Param in_kit

The source ExportSTEPOptionsKit to copy.

HPS.Exchange.ExportSTEPOptionsKit SetAnalyticsAsNURBS (bool in_state)

Sets whether to convert analytic surfaces (planes, cones, cylinder, etc.) to NURBS surfaces for export. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bSaveAnalyticsToNurbs.

See

Default value

Param in_state

Whether to convert analytic surfaces to NURBS surfaces for export.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetApplication (string in_name)

Sets the application name to put in the STEP data. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_pcApplication.

Param in_name

UTF8-encoded application name to put in the STEP data.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetAttributes (bool in_state)

Sets whether to export attributes. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWriteAttributes.

Param in_state

Whether to export attributes.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetCurves (bool in_state)

Sets whether to export curves. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWriteUVCurves.

Param in_state

Whether to export curves.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetFacetedAsWireframe (bool in_state)

Sets whether to convert polyhedrics to wireframe data for export. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bSaveFacetedToWireframe.

See

Default value

Param in_state

Whether to convert polyhedrics to wireframe data for export.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetFormat (HPS.Exchange.STEP.Format in_format)

Sets the format of the STEP data to export. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_eStepFormat.

See

Default value

Param in_format

The format of the STEP data to export.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetNameShortening (bool in_state)

Sets whether to shorten names in the STEP data for export. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bUseShortNames.

See

Default value

Param in_state

Whether to shorten names in the STEP data for export.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetPMI (bool in_state)

Sets whether to export PMI. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWritePMI.

Param in_state

Whether to export PMI.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetPMIAsTessellated (bool in_state)

Sets whether to export PMI as tessellated rather than polyline. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWritePMIAsTessellated.

Param in_state

Whether to export PMI as tessellated.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetPMIWithSemantic (bool in_state)

Sets whether to export PMI with semantic information. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_bWritePMIWithSemantic.

Param in_state

Whether to export PMI semantic information.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit SetVersion (string in_version)

Sets the version string to put in the STEP data. This corresponds to the value that will be passed to A3DRWParamsExportStepData::m_pcVersion.

Param in_version

UTF8-encoded version string to put in the STEP data.

Return

A reference to this ExportSTEPOptionsKit.

void Show (out HPS.Exchange.ExportSTEPOptionsKit out_kit)

Copies this ExportSTEPOptionsKit into the given ExportSTEPOptionsKit.

Param out_kit

The ExportSTEPOptionsKit to populate with the contents of this ExportSTEPOptionsKit.

bool ShowAnalyticsAsNURBS (out bool out_state)

Shows the analytics to NURBS conversion setting.

Param out_state

Whether to convert analytic surfaces to NURBS surfaces for export.

Return

true if an analytics to NURBS conversion setting was specified, false otherwise.

bool ShowApplication (out string out_name)

Shows the application name setting.

Param out_name

The application name to put in the STEP data.

Return

true if an application name setting was specified, false otherwise.

bool ShowAttributes (out bool out_state)

Shows the attributes setting.

Param out_state

Whether to export attributes.

Return

true if an attributes setting was specified, false otherwise.

bool ShowCurves (out bool out_state)

Shows the curves setting.

Param out_state

Whether to export curves.

Return

true if a curves setting was specified, false otherwise.

bool ShowFacetedAsWireframe (out bool out_state)

Shows the faceted to wireframe conversion setting.

Param out_state

Whether to convert polyhedrics to wireframe data for export.

Return

true if a faceted to wireframe conversion setting was specified, false otherwise.

bool ShowFormat (out HPS.Exchange.STEP.Format out_format)

Shows the format setting.

Param out_format

The format of the STEP data to export.

Return

true if a format setting was specified, false otherwise.

bool ShowNameShortening (out bool out_state)

Shows the name shortening setting.

Param out_state

Whether to shorten names in the STEP data for export.

Return

true if a name shortening setting was specified, false otherwise.

bool ShowPMI (out bool out_state)

Shows the pmi setting.

Param out_state

Whether to export PMI.

Return

true if a PMI setting was specified, false otherwise.

bool ShowPMIAsTessellated (out bool out_state)

Shows the pmi as tessellated setting.

Param out_state

Whether to export PMI as tessellated information.

Return

true if a PMI as tessellated setting was specified, false otherwise.

bool ShowPMIWithSemantic (out bool out_state)

Shows the pmi with semantic setting.

Param out_state

Whether to export PMI with semantic information.

Return

true if a PMI with semantic setting was specified, false otherwise.

bool ShowVersion (out string out_version)

Shows the version string setting.

Param out_version

The version string to put in the STEP data.

Return

true if a version string setting was specified, false otherwise.

HPS.Exchange.ExportSTEPOptionsKit UnsetAnalyticsAsNURBS ()

Removes the analytics to NURBS conversion setting.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetApplication ()

Removes the application name setting.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetAttributes ()

Removes the attributes setting.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetCurves ()

Removes the curves setting.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetEverything ()

Removes all settings from this ExportSTEPOptionsKit.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetFacetedAsWireframe ()

Removes the faceted to wireframe conversion setting.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetFormat ()

Removes the format setting.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetNameShortening ()

Removes the name shortening setting.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetPMI ()

Removes the PMI setting.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetPMIAsTessellated ()

Removes the PMI as tessellated setting.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetPMIWithSemantic ()

Removes the PMI with semantic setting.

Return

A reference to this ExportSTEPOptionsKit.

HPS.Exchange.ExportSTEPOptionsKit UnsetVersion ()

Removes the version string setting.

Return

A reference to this ExportSTEPOptionsKit.

Public Static Functions

HPS.Exchange.ExportSTEPOptionsKit GetDefault ()

Creates an ExportSTEPOptionsKit 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.ExportSTEP.

Return

An ExportSTEPOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ExportSTEPOptionsKit a, HPS.Exchange.ExportSTEPOptionsKit b)

bool operator== (HPS.Exchange.ExportSTEPOptionsKit a, HPS.Exchange.ExportSTEPOptionsKit b)

class ExportSTLOptionsKit : public HPS.SprocketKit

The HPS.Exchange.ExportSTLOptionsKit class is a user space object. It contains settings controlling how STL data is exported via Exchange. Calling HPS.Exchange.ExportSTLOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportSTLOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportSTLOptionsKit in_kit)

Check if the source ExportSTLOptionsKit is equivalent to this ExportSTLOptionsKit.

Param in_kit

The source ExportSTLOptionsKit to compare to this ExportSTLOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportSTLOptionsKit ()

The default constructor creates an empty ExportSTLOptionsKit object.

ExportSTLOptionsKit (HPS.Exchange.ExportSTLOptionsKit in_kit)

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

Param in_kit

The source ExportSTLOptionsKit to copy.

override int GetHashCode ()

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.Exchange.ExportSTLOptionsKit in_kit)

Copies the source ExportSTLOptionsKit into this ExportSTLOptionsKit.

Param in_kit

The source ExportSTLOptionsKit to copy.

HPS.Exchange.ExportSTLOptionsKit SetBinary (bool in_state)

Sets whether to write STL data in binary form. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_bBinaryFile.

See

Default value

Param in_state

Whether to write STL data in binary form.

Return

A reference to this ExportSTLOptionsKit.

HPS.Exchange.ExportSTLOptionsKit SetCurrentTessellationRetention (bool in_state)

Sets whether to keep the current tessellation. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_bKeepCurrentTessellation.

See

Default value

Param in_state

Whether to keep the current tessellation.

Return

A reference to this ExportSTLOptionsKit.

HPS.Exchange.ExportSTLOptionsKit SetMaximumEdgeLength (double in_length)

Sets the maximum length of triangle edges in the tessellation generated for BRep data. This is only relevant if the tessellation level is set to Tessellation.Level.UserDefined. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_dMaximalTriangleEdgeLength.

See

Default value

Param in_length

The maximum length of triangle edges in the tessellation generated for BRep data. The value must be non-negative.

Return

A reference to this ExportSTLOptionsKit.

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

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

See

Default value

Param in_type

The accuracy to use for tessellation generation.

Return

A reference to this ExportSTLOptionsKit.

HPS.Exchange.ExportSTLOptionsKit 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 using the standard or accurate tessellation algorithm. This implicitly sets A3DRWParamsExportStlData::m_eTessellationLevel to kA3DTessLODUserDefined.

Param in_limit_type

The type of the chord limit to be specified.

Param in_limit

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

Param in_angle_tolerance

The 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 A3DRWParamsExportStlData::m_dAngleToleranceDeg.

Return

A reference to this ExportSTLOptionsKit.

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

Sets the predefined quality of the tessellation that will be generated for BRep data using the standard tessellation algorithm. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_eTessellationLevelOfDetail.

See

Default value

Param in_level

The predefined quality of the tessellation that will be generated for BRep data using the standard tessellation algorithm.

Return

A reference to this ExportSTLOptionsKit.

HPS.Exchange.ExportSTLOptionsKit SetUnits (HPS.Exchange.Units in_units)

Sets the units to associate with the STL export. This corresponds to the value that will be passed to A3DRWParamsExportStlData::m_eExportUnit. This function will result in a scale being applied to the exported model. The CADModel will NOT have a unit associated with it, since STL is a unit-less format. For example: exporting a cube with a 1mm side with Units set to Meter, will cause the side of the cube to shrink by a factor of 1000, since every unit in the file, which used to correspond to one mm, now corresponds to a meter. This is useful in the case where the STL file needs to be loaded in a scene alongside another model, so that the units of the two models can match.

See

Default value

Param in_units

The units to associate with the export. Passing Units.Unknown will preserve the original units.

Return

A reference to this ExportSTLOptionsKit.

void Show (out HPS.Exchange.ExportSTLOptionsKit out_kit)

Copies this ExportSTLOptionsKit into the given ExportSTLOptionsKit.

Param out_kit

The ExportSTLOptionsKit to populate with the contents of this ExportSTLOptionsKit.

bool ShowBinary (out bool out_state)

Shows the binary export setting.

Param out_state

Whether to write STL data in binary form.

Return

true if a binary export setting was specified, false otherwise.

bool ShowCurrentTessellationRetention (out bool out_state)

Shows the current tessellation retention setting.

Param out_state

Whether to keep the current tessellation.

Return

true if a current tessellation retention setting was specified, false otherwise.

bool ShowMaximumEdgeLength (out double out_length)

Shows the tessellation maximum edge length setting.

Param out_length

The tessellation maximum edge length setting.

Return

true if a tessellation maximum edge length setting was specified, false otherwise.

bool ShowTessellationAccuracy (out HPS.Exchange.Tessellation.Accuracy out_type)

Shows the tessellation accuracy setting.

Param out_type

The type of the tessellation accuracy which was specified.

Return

true if a tessellation accuracy setting was specified, false otherwise.

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.

Param out_type

The type of the tessellation level setting which was specified.

Param out_level

The predefined quality of the tessellation that will be generated for BRep data using the standard tessellaiton algorithm. This is only valid if out_type is Tessellation.Type.Standard.

Param out_limit_type

The type of chord limit which was specified. This is only valid if out_type is Tessellation.Type.Custom.

Param out_limit

The 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 Tessellation.Type.Custom.

Param out_angle_tolerance

The maximum angle in degrees between two consecutive wire elements in the generated tessellation. This is only valid if out_type is Tessellation.Type.Custom.

Return

true if a tessellation level setting was specified, false otherwise.

bool ShowUnits (out HPS.Exchange.Units out_units)

Shows the binary export setting.

Param out_units

The units that will be associated with this export.

Return

true if a units export setting was specified, false otherwise.

HPS.Exchange.ExportSTLOptionsKit UnsetBinary ()

Removes the binary export setting.

Return

A reference to this ExportSTLOptionsKit.

HPS.Exchange.ExportSTLOptionsKit UnsetCurrentTessellationRetention ()

Removes the current tessellation retention setting.

Return

A reference to this ExportSTLOptionsKit.

HPS.Exchange.ExportSTLOptionsKit UnsetEverything ()

Removes all settings from this ExportSTLOptionsKit.

Return

A reference to this ExportSTLOptionsKit.

HPS.Exchange.ExportSTLOptionsKit UnsetMaximumEdgeLength ()

Removes the tessellation maximum edge length setting.

Return

A reference to this ExportSTLOptionsKit.

HPS.Exchange.ExportSTLOptionsKit UnsetTessellationAccuracy ()

Removes the tessellation accuracy setting.

Return

A reference to this ExportSTLOptionsKit.

HPS.Exchange.ExportSTLOptionsKit UnsetTessellationLevel ()

Removes the tessellation level setting.

Return

A reference to this ExportSTLOptionsKit.

HPS.Exchange.ExportSTLOptionsKit UnsetUnits ()

Removes the units export setting.

Return

A reference to this ExportSTLOptionsKit.

Public Static Functions

HPS.Exchange.ExportSTLOptionsKit GetDefault ()

Creates an ExportSTLOptionsKit 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.ExportSTL.

Return

An ExportSTLOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ExportSTLOptionsKit a, HPS.Exchange.ExportSTLOptionsKit b)

bool operator== (HPS.Exchange.ExportSTLOptionsKit a, HPS.Exchange.ExportSTLOptionsKit b)

class ExportU3DOptionsKit : public HPS.SprocketKit

The HPS.Exchange.ExportU3DOptionsKit class is a user space object. It contains settings controlling how U3D data is exported via Exchange. Calling HPS.Exchange.ExportU3DOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportU3DOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportU3DOptionsKit in_kit)

Check if the source ExportU3DOptionsKit is equivalent to this ExportU3DOptionsKit.

Param in_kit

The source ExportU3DOptionsKit to compare to this ExportU3DOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportU3DOptionsKit ()

The default constructor creates an empty ExportU3DOptionsKit object.

ExportU3DOptionsKit (HPS.Exchange.ExportU3DOptionsKit in_kit)

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

Param in_kit

The source ExportU3DOptionsKit to copy.

override int GetHashCode ()

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.Exchange.ExportU3DOptionsKit in_kit)

Copies the source ExportU3DOptionsKit into this ExportU3DOptionsKit.

Param in_kit

The source ExportU3DOptionsKit to copy.

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 A3DRWParamsExportU3DData::m_ucMeshQualityValue.

Param in_level

The level of compression to apply to tessellations in the U3D data for export. This value should be in the range [0, 100].

Return

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

See

Default value

Param in_version

The version of the U3D data to export.

Return

A reference to this ExportU3DOptionsKit.

void Show (out HPS.Exchange.ExportU3DOptionsKit out_kit)

Copies this ExportU3DOptionsKit into the given ExportU3DOptionsKit.

Param out_kit

The ExportU3DOptionsKit to populate with the contents of this ExportU3DOptionsKit.

bool ShowCompression (out byte out_level)

Shows the compression setting.

Param out_level

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

Return

true if a compression setting was specified, false otherwise.

bool ShowVersion (out HPS.Exchange.U3D.Version out_version)

Shows the version setting.

Param out_version

The version of the U3D data to export.

Return

true if a version setting was specified, false otherwise.

HPS.Exchange.ExportU3DOptionsKit UnsetCompression ()

Removes the compression setting.

Return

A reference to this ExportU3DOptionsKit.

HPS.Exchange.ExportU3DOptionsKit UnsetEverything ()

Removes all settings from this ExportU3DOptionsKit.

Return

A reference to this ExportU3DOptionsKit.

HPS.Exchange.ExportU3DOptionsKit UnsetVersion ()

Removes the version setting.

Return

A reference to this ExportU3DOptionsKit.

Public Static Functions

HPS.Exchange.ExportU3DOptionsKit GetDefault ()

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.

Return

An ExportU3DOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ExportU3DOptionsKit a, HPS.Exchange.ExportU3DOptionsKit b)

bool operator== (HPS.Exchange.ExportU3DOptionsKit a, HPS.Exchange.ExportU3DOptionsKit b)

class ExportXMLOptionsKit : public HPS.SprocketKit

The HPS.Exchange.ExportXMLOptionsKit class is a user space object. It contains settings controlling how XML data is exported via Exchange. Calling HPS.Exchange.ExportXMLOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportXMLOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ExportXMLOptionsKit in_kit)

Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit.

Param in_kit

The source ExportXMLOptionsKit to compare to this ExportXMLOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportXMLOptionsKit ()

The default constructor creates an empty ExportXMLOptionsKit object.

ExportXMLOptionsKit (HPS.Exchange.ExportXMLOptionsKit in_kit)

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

Param in_kit

The source ExportXMLOptionsKit to copy.

override int GetHashCode ()

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.Exchange.ExportXMLOptionsKit in_kit)

Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit.

Param in_kit

The source ExportXMLOptionsKit to copy.

HPS.Exchange.ExportXMLOptionsKit SetMaterials (bool in_state)

Sets whether to export materials. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportColorMaterial.

See

Default value

Param in_state

Whether to export materials.

Return

A reference to this ExportXMLOptionsKit.

HPS.Exchange.ExportXMLOptionsKit SetMetadata (bool in_state)

Sets whether to export metadata. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportMetadata.

See

Default value

Param in_state

Whether to export metadata.

Return

A reference to this ExportXMLOptionsKit.

HPS.Exchange.ExportXMLOptionsKit SetTransformations (bool in_state)

Sets whether to export transformations. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportTransformations.

See

Default value

Param in_state

Whether to export transformations.

Return

A reference to this ExportXMLOptionsKit.

void Show (out HPS.Exchange.ExportXMLOptionsKit out_kit)

Copies this ExportXMLOptionsKit into the given ExportXMLOptionsKit.

Param out_kit

The ExportXMLOptionsKit to populate with the contents of this ExportXMLOptionsKit.

bool ShowMaterials (out bool out_state)

Shows the material export setting.

Param out_state

Whether to export materials.

Return

true if a material export setting was specified, false otherwise.

bool ShowMetadata (out bool out_state)

Shows the metadata export setting.

Param out_state

Whether to export metadata.

Return

true if a metadata export setting was specified, false otherwise.

bool ShowTransformations (out bool out_state)

Shows the transformation export setting.

Param out_state

Whether to export transformations.

Return

true if a transformation export setting was specified, false otherwise.

HPS.Exchange.ExportXMLOptionsKit UnsetEverything ()

Removes all settings from this ExportXMLOptionsKit.

Return

A reference to this ExportXMLOptionsKit.

HPS.Exchange.ExportXMLOptionsKit UnsetMaterials ()

Removes the material export setting.

Return

A reference to this ExportXMLOptionsKit.

HPS.Exchange.ExportXMLOptionsKit UnsetMetadata ()

Removes the metadata export setting.

Return

A reference to this ExportXMLOptionsKit.

HPS.Exchange.ExportXMLOptionsKit UnsetTransformations ()

Removes the transformation export setting.

Return

A reference to this ExportXMLOptionsKit.

Public Static Functions

HPS.Exchange.ExportXMLOptionsKit GetDefault ()

Creates an ExportXMLOptionsKit 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.ExportXML.

Return

An ExportXMLOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ExportXMLOptionsKit a, HPS.Exchange.ExportXMLOptionsKit b)

bool operator== (HPS.Exchange.ExportXMLOptionsKit a, HPS.Exchange.ExportXMLOptionsKit b)

class Factory : public HPS.Sprocket

The Factory class is used to create and Exchange objects which inherit from HPS.Component or one of its subclasses.

Public Functions

override void Dispose ()

Factory (HPS.Exchange.Factory in_that)

Public Static Functions

HPS.Exchange.CADModel CreateCADModel ()

Creates a new Exchange.CADModel.

HPS.Exchange.CADModel CreateCADModel (HPS.Model in_model)

Creates a new Exchange.CADModel.

Param in_model

The Model associated with the newly created Exchange.CADModel.

HPS.Exchange.CADModel CreateCADModel (HPS.Model in_model, IntPtr in_entity)

Creates a new Exchange.CADModel.

Param in_model

The Model associated with the newly created Exchange.CADModel.

Param in_entity

The Exchange entity associated with the newly created Exchange.CADModel.

HPS.Exchange.CADModel CreateCADModel (HPS.Model in_model, IntPtr in_entity, bool in_owns_entity)

Creates a new Exchange.CADModel.

Param in_model

The Model associated with the newly created Exchange.CADModel.

Param in_entity

The Exchange entity associated with the newly created Exchange.CADModel.

Param in_owns_entity

Whether the newly created Exchange.CADModel owns the associated A3DAsmModelFile (see the documentation for Exchange.CADModel::GetEntityOwnership for more details).

HPS.Exchange.Capture CreateCapture (HPS.Component in_owner)

Creates a new Exchange.Capture as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Capture.

HPS.Exchange.Capture CreateCapture (HPS.Component in_owner, IntPtr in_entity)

Creates a new Exchange.Capture as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Capture.

Param in_entity

The Exchange entity associated with the newly created Exchange.Capture.

HPS.Exchange.Capture CreateCapture (HPS.Component in_owner, IntPtr in_entity, bool in_is_default)

Creates a new Exchange.Capture as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Capture.

Param in_entity

The Exchange entity associated with the newly created Exchange.Capture.

Param in_is_default

Whether the newly created Exchange.Capture is the default capture for the CADModel, i.e., the capture that will be activated when CADModel.ActivateDefaultCapture is invoked. Note that if one is creating a default capture, the owner must be a CADModel (or subclass thereof) and this will delete the old default capture on that CADModel if one was present.

HPS.Exchange.Component CreateComponent (HPS.Component in_owner, HPS.Component.ComponentType in_type)

Creates a new Exchange.Component as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Component.

Param in_type

The type of Exchange.Component to create.

HPS.Exchange.Component CreateComponent (HPS.Component in_owner, HPS.Component.ComponentType in_type, IntPtr in_entity)

Creates a new Exchange.Component as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Component.

Param in_type

The type of Exchange.Component to create.

Param in_entity

The Exchange entity associated with the newly created Exchange.Component.

HPS.Exchange.Filter CreateFilter (HPS.Component in_owner)

Creates a new Exchange.Filter as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Filter.

HPS.Exchange.Filter CreateFilter (HPS.Component in_owner, IntPtr in_entity)

Creates a new Exchange.Filter as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Filter.

Param in_entity

The Exchange entity associated with the newly created Exchange.Filter.

HPS.Exchange.Sheet CreateSheet (HPS.Component in_owner)

Creates a new Exchange.Sheet as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Sheet.

HPS.Exchange.Sheet CreateSheet (HPS.Component in_owner, IntPtr in_entity)

Creates a new Exchange.Sheet as a subcomponent of a given Component.

Param in_owner

The HPS.Component which owns the newly created Exchange.Sheet.

Param in_entity

The Exchange entity associated with the newly created Exchange.Sheet.

HPS.Exchange.Component DeInstanceComponent (HPS.ComponentPath in_component_path)

Returns the component at whose level changes can be made without influencing other instances of the same component. The ComponentPath passed to this function needs to include a component of type Representation Item.

Param in_component_path

The ComponentPath to operate on.

Return

The newly de-instanced Component.

class File : public IDisposable

The File class provides functions to import and export CAD files via Exchange.

Public Types

enum Format

Enumerates the formats Exchange can recognize.

Values:

Unsupported

Format cannot be imported via Exchange.

ACIS

ACIS file (A3DEModellerType::kA3DModellerAcis).

CADDS

CADDS file (A3DEModellerType::kA3DModellerCadds).

CATIAV4

CATIA V4 file (A3DEModellerType::kA3DModellerCatia).

CATIAV5

CATIA V5 file (A3DEModellerType::kA3DModellerCatiaV5).

CGR

CATIA Graphical Represenation file (A3DEModellerType::kA3DModellerCgr).

COLLADA

COLLADA (DAE) file (A3DEModellerType::kA3DModellerDAE).

CreoProE

Creo (Pro/E) file (A3DEModellerType::kA3DModellerProE).

DWG

DWG file (A3DEModellerType::kA3DModellerDWG).

DXF

Dxf file (A3DEModellerType::kA3DModellerDxf).

IDEAS

I-DEAS file (A3DEModellerType::kA3DModellerIdeas).

IFC

Industry Foundation Classes (IFC) file (A3DEModellerType::kA3DModellerIFC).

IGES

IGES file (A3DEModellerType::kA3DModellerIges).

Inventor

Autodesk Inventor file (A3DEModellerType::kA3DModellerInventor).

JT

JT file (A3DEModellerType::kA3DModellerJt).

KeyholeMarkupLanguage

Keyhole Markup Language (KMZ) file (A3DEModellerType::kA3DModellerKMZ).

LatticeXVL

Lattice XVL file (A3DEModellerType::kA3DModellerXvl).

OneSpaceDesigner

OneSpace Designer file (A3DEModellerType::kA3DModellerOneSpaceDesigner).

Parasolid

Parasolid file (A3DEModellerType::kA3DModellerParasolid).

PDF

PDF file (A3DEModellerType::kA3DModellerPDF).

PRC

Product Representation Compact (PRC) file (A3DEModellerType::kA3DModellerPrc).

Rhino

Rhinocerous 3D file (A3DEModellerType::kA3DModellerRhino).

NXUnigraphics

NX (Unigraphics) file (A3DEModellerType::kA3DModellerUnigraphics).

SolidEdge

Solid Edge file (A3DEModellerType::kA3DModellerSE).

SolidWorks

SolidWorks file (A3DEModellerType::kA3DModellerSlw).

STEP

STEP file (A3DEModellerType::kA3DModellerStep).

StereoLithography

Stereo Lithography (STL) file (A3DEModellerType::kA3DModellerStl).

ThreeDStudioMax

Autodesk 3D Studio Max file (A3DEModellerType::kA3DModeller3DS).

ThreeDXML

3DXML file (A3DEModellerType::kA3DModeller3dxml).

Universal3D

Universal 3D (U3D) file (A3DEModellerType::kA3DModellerU3D).

VDAFS

VDA-FS file (A3DEModellerType::kA3DModellerVda).

VRML

VRML file (A3DEModellerType::kA3DModellerWrl).

WavefrontObject

Wavefront Object (OBJ) file (A3DEModellerType::kA3DModellerOBJ).

Revit

Revit file (A3DEModellerType::kA3DModellerRevit).

GLTF

GLTF file (A3DEModellerType::kA3DModellerGLTF).

DWF

Autodesk DWF file (A3DEModellerType::kA3DModellerDwf).

FBX

FBX file (A3DEModellerType::kA3DModellerFbx).

STEPXML

STEP XML file (A3DEModellerType::kA3DModellerStepXml)

ThreeMF

3MF file (A3DEModellerType::kA3DModeller3mf)

Navisworks

Navisworks file (A3DEModellerType::kA3DModellerNavisworks)

Public Functions

void Dispose ()

File (HPS.Exchange.File in_that)

Public Static Functions

HPS.Exchange.ExportNotifier Export3MF (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.Export3MFOptionsKit in_options)

Performs an asynchronous 3MF export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_cad_model

The CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.

Param in_file_name

The name of the file to write the 3MF data to.

Param in_options

The options controlling the export of the 3MF data.

HPS.Exchange.ExportNotifier Export3MF (HPS.KeyPath in_source, string in_file_name, HPS.Exchange.Export3MFOptionsKit in_options)

Performs an asynchronous 3MF export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_source

A key path containing the data to export. The geometry and segments under this key path will be used to create the A3DAsmModelFile to export as 3MF.

Param in_file_name

The name of the file to write the 3MF data to.

Param in_options

The options controlling the export of the 3MF data.

Return

An ExportNotfier object that can be used to query the export progress and status.

HPS.Exchange.ExportNotifier Export3MF (HPS.KeyPath[] in_source, string in_file_name, HPS.Exchange.Export3MFOptionsKit in_options)

Performs an asynchronous 3MF export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_source

An array of key paths containing the data to export. The geometry and segments under these key paths will be used to create the A3DAsmModelFile to export as 3MF.

Param in_file_name

The name of the file to write the 3MF data to.

Param in_options

The options controlling the export of the 3MF data.

Return

An ExportNotfier object that can be used to query the export progress and status.

void ExportACIS (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportACISOptionsKit in_options)

Performs a synchronous ACIS export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_cad_model

The CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.

Param in_file_name

The name of the file to write the ACIS data to.

Param in_options

The options controlling the export of the ACIS data.

void ExportFBX (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportFBXOptionsKit in_options)

Performs a synchronous FBX export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_cad_model

The CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.

Param in_file_name

The name of the file to write the FBX data to.

Param in_options

The options controlling the export of the FBX data.

void ExportGLTF (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportGLTFOptionsKit in_options)

Performs a synchronous GLTF export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_cad_model

The CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.

Param in_file_name

The name of the file to write the GLTF data to.

Param in_options

The options controlling the export of the GLTF data.

void ExportIGES (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportIGESOptionsKit in_options)

Performs a synchronous IGES export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_cad_model

The CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.

Param in_file_name

The name of the file to write the IGES data to.

Param in_options

The options controlling the export of the IGES data.

void ExportJT (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportJTOptionsKit in_options)

Performs a synchronous JT export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_cad_model

The CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.

Param in_file_name

The name of the file to write the JT data to.

Param in_options

The options controlling the export of the JT data.

void ExportOBJ (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportOBJOptionsKit in_options)

Performs a synchronous OBJ export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_cad_model

The CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.

Param in_file_name

The name of the file to write the OBJ data to.

Param in_options

The options controlling the export of the OBJ data.

void ExportParasolid (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportParasolidOptionsKit in_options)

Performs a synchronous Parasolid export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_cad_model

The CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.

Param in_file_name

The name of the file to write the Parasolid data to.

Param in_options

The options controlling the export of the Parasolid data.

HPS.Exchange.ExportNotifier ExportPRC (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportPRCOptionsKit in_options)

Performs an asynchronous PRC export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_cad_model

The CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.

Param in_file_name

The name of the file to write the PRC data to.

Param in_options

The options controlling the export of the PRC data.

Return

An ExportNotfier object that can be used to query the export progress and status.

HPS.Exchange.ExportNotifier ExportPRC (HPS.KeyPath in_source)

Performs an asynchronous creation of an A3DAsmModelFile from a KeyPath.

Param in_source

A key path containing the data to export. The geometry and segments under these key paths will be used to create the A3DAsmModelFile.

Return

An ExportNotfier object that can be used to query the export progress and status.

HPS.Exchange.ExportNotifier ExportPRC (HPS.KeyPath in_source, string in_file_name)

Performs an asynchronous PRC export from an A3DAsmModelFile created from a KeyPath.

Param in_source

An array of key paths containing the data to export. The geometry and segments under these key paths will be used to create the A3DAsmModelFile to export as PRC.

Param in_file_name

The name of the file to write the PRC data to.

Return

An ExportNotfier object that can be used to query the export progress and status.

HPS.Exchange.ExportNotifier ExportPRC (HPS.KeyPath in_source, string in_file_name, bool in_compress_tessellation)

Performs an asynchronous PRC export from an A3DAsmModelFile created from a KeyPath.

Param in_source

An array of key paths containing the data to export. The geometry and segments under these key paths will be used to create the A3DAsmModelFile to export as PRC.

Param in_file_name

The name of the file to write the PRC data to.

Param in_compress_tessellation

Whether to compress the tessellation data in the PRC data. Defaults to false.

Return

An ExportNotfier object that can be used to query the export progress and status.

HPS.Exchange.ExportNotifier ExportPRC (HPS.KeyPath[] in_source)

Performs an asynchronous creation of an A3DAsmModelFile from a KeyPathArray.

Param in_source

An array of key paths containing the data to export. The geometry and segments under these key paths will be used to create the A3DAsmModelFile.

Return

An ExportNotfier object that can be used to query the export progress and status.

HPS.Exchange.ExportNotifier ExportPRC (HPS.KeyPath[] in_source, string in_file_name)

Performs an asynchronous PRC export from an A3DAsmModelFile created from a KeyPathArray.

Param in_source

An array of key paths containing the data to export. The geometry and segments under these key paths will be used to create the A3DAsmModelFile to export as PRC.

Param in_file_name

The name of the file to write the PRC data to.

Return

An ExportNotfier object that can be used to query the export progress and status.

HPS.Exchange.ExportNotifier ExportPRC (HPS.KeyPath[] in_source, string in_file_name, bool in_compress_tessellation)

Performs an asynchronous PRC export from an A3DAsmModelFile created from a KeyPathArray.

Param in_source

An array of key paths containing the data to export. The geometry and segments under these key paths will be used to create the A3DAsmModelFile to export as PRC.

Param in_file_name

The name of the file to write the PRC data to.

Param in_compress_tessellation

Whether to compress the tessellation data in the PRC data. Defaults to false.

Return

An ExportNotfier object that can be used to query the export progress and status.

void ExportSTEP (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportSTEPOptionsKit in_options)

Performs a synchronous STEP export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_cad_model

The CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.

Param in_file_name

The name of the file to write the STEP data to.

Param in_options

The options controlling the export of the STEP data.

void ExportSTL (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportSTLOptionsKit in_options)

Performs a synchronous STL export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_cad_model

The CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.

Param in_file_name

The name of the file to write the STL data to.

Param in_options

The options controlling the export of the STL data.

void ExportU3D (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportU3DOptionsKit in_options)

Performs a synchronous U3D export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_cad_model

The CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.

Param in_file_name

The name of the file to write the U3D data to.

Param in_options

The options controlling the export of the U3D data.

void ExportVRML (HPS.Exchange.CADModel in_cad_model, string in_file_name)

Performs a synchronous VRML export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_cad_model

The CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.

Param in_file_name

The name of the file to write the VRML data to.

void ExportXML (HPS.Exchange.CADModel in_cad_model, string in_file_name, HPS.Exchange.ExportXMLOptionsKit in_options)

Performs a synchronous XML export of the given CADModel with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_cad_model

The CADModel containing the data to export. This CADModel must have come from a CAD file imported via Exchange, if it did not, the export will not succeed.

Param in_file_name

The name of the file to write the XML data to.

Param in_options

The options controlling the export of the XML data.

HPS.Exchange.Configuration[] GetConfigurations (string in_file_name)

Gets a list of configurations for the given file (if any). It should be called prior to Import if a file has configurations and the user wants or needs to specify the configuration to import and requires a list of the available configurations. If there are configurations, the function will return an array which has been populated with the list of configurations. If there are no configurations, the function will return an empty array. May throw an IOException if a problem is encountered when querying the configurations.

HPS.Exchange.File.Format GetFormat (string in_file_name)

Gets the format for the given file as determined by Exchange. May throw an IOException if a problem is encountered when querying the format.

void GetInformation (string in_file_name, out HPS.Exchange.File.Format out_format, out string out_model_name, out string out_version, out string out_author, out string out_organization, out string out_time_stamp)

HPS.ImageKit GetThumbnailImage (string in_file_name)

HPS.Exchange.ImportNotifier Import (byte[] in_prc_data, HPS.Exchange.ModelFileImportOptionsKit in_options)

Performs an asynchronous import of the specified PRC data with the provided options. May throw an IOException prior to starting the asynchronous import. Note that if the import is successful, the CADModel created from this import will own its associated A3DAsmModelFile (see Exchange.CADModel.GetEntityOwnership for more details).

Param in_prc_data

Buffer of PRC data to import.

Param in_options

The options controlling the import of the CAD file. Whether these options will have any effect depends on what is contained in the PRC data.

Return

An ImportNotfier object that can be used to query the import progress and status.

HPS.Exchange.ImportNotifier Import (IntPtr in_model_file, HPS.Exchange.ModelFileImportOptionsKit in_options)

Performs an asynchronous import of the specified A3DAsmModelFile with the provided options. May throw an IOException prior to starting the asynchronous import. Note that if the import is successful, the CADModel created from this import will not own its associated A3DAsmModelFile (see Exchange.CADModel.GetEntityOwnership for more details).

Param in_model_file

The A3DAsmModelFile to import.

Param in_options

The options controlling the import of the CAD file. Whether these options will have any effect depends on how the A3DAsmModelFile was created.

Return

An ImportNotfier object that can be used to query the import progress and status.

HPS.Exchange.ImportNotifier Import (string in_file_name, HPS.Exchange.ImportOptionsKit in_options)

Performs an asynchronous import of the specified CAD file with the provided options. May throw an IOException prior to starting the asynchronous import. Note that if the import is successful, the CADModel created from this import will own its associated A3DAsmModelFile (see Exchange.CADModel.GetEntityOwnership for more details).

Param in_file_name

The name of the CAD file to import.

Param in_options

The options controlling the import of the CAD file.

Return

An ImportNotfier object that can be used to query the import progress and status.

HPS.Exchange.TranslationNotifier Translate (string in_file_name, HPS.Exchange.ImportOptionsKit in_options, HPS.Exchange.TranslationOptionsKit in_translation_options)

Asynchronously translates the specified CAD files into an array of Parasolid parts, using the options provided. A valid Parasolid session is required for this function to succeed.

Param in_file_name

The name of the CAD file to translate.

Param in_options

The options controlling the translation of the CAD file.

Param in_translation_options

Options used during the translation.

Return

An TranslationNotifier object that can be used to query the import progress and status.

class Filter : public HPS.Filter

The Filter class is a smart pointer. It represents an A3DAsmFilter in Exchange. The primary purpose of this class is simply to provide access to the underlying A3DAsmFilter pointer for use by Exchange library functions.

Public Functions

override void Dispose ()

Filter ()

The default constructor creates an uninitialized Filter object. The Type() function will return Type.None.

Filter (HPS.Component in_that)

This constructor creates a Filter object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange.Filter object. Otherwise the copy will fail and the resulting Exchange.Filter will be invalid.

Param in_that

The source Component to copy.

Filter (HPS.Exchange.Filter in_that)

This constructor creates an Exchange.Filter object that shares the underlying smart-pointer of the source HPS.Filter. The copy will only be successful if the source component is really an upcast of an Exchange.Filter object. Otherwise the copy will fail and the resulting Exchange.Filter will be invalid.

Param in_that

The source HPS.Filter to copy.

Filter (HPS.Filter in_that)

This constructor creates an Exchange.Filter object that shares the underlying smart-pointer of the source HPS.Filter. The copy will only be successful if the source component is really an upcast of an Exchange.Filter object. Otherwise the copy will fail and the resulting Exchange.Filter will be invalid.

Param in_that

The source HPS.Filter to copy.

IntPtr GetExchangeEntity ()

Gets the A3DEntity pointer corresponding to this Exchange.Filter.

Return

The A3DEntity pointer corresponding to this Exchange.Filter.

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.

class ImportNotifier : public HPS.IONotifier

The ImportNotifier class is a smart-pointer that is tied to a file import. It is used to interact with an ongoing import or get the results from a completed import.

Public Functions

void Assign (HPS.Exchange.ImportNotifier in_that)

Associate this ImportNotifier with the same file import as the source ImportNotifier.

Param in_that

The source ImportNotifier for the assignment.

override void Dispose ()

HPS.Exchange.CADModel GetCADModel ()

Get the CADModel for the file import. Throws an IOException if the import is not complete, was not successful or was canceled.

Return

The CADModel for a successful file import.

double GetImportTime ()

Get the number of milliseconds it took Exchange to read the CAD file(s) and generate the corresponding PRC data. Throws an IOException if the import is not complete, was not successful or was canceled.

double GetParseTime ()

Get the number of milliseconds it took Visualize to parse the PRC data and create the corresponding scene graph. Throws an IOException if the import is not complete, was not successful or was canceled.

IntPtr GetPRCReadHelper ()

Get the PRC Read Helper for the file import. Throws an IOException if the import is not complete, was not successful or was canceled. The returned value will only be non-null if the Exchange.ImportOptionsKit.SetPRCReadHelper option was set to true and the file that was imported was a PRC file or a PRC stream.

See

Exchange.ImportOptionsKit.SetPRCReadHelper

Return

The A3DRWParamsPrcReadHelper * created during a successful file import.

ImportNotifier ()

The default constructor creates an ImportNotifier object which is not tied to any file import.

ImportNotifier (HPS.Exchange.ImportNotifier in_that)

The copy constructor creates a new ImportNotifier object that is associated with the same file import as the source ImportNotifier.

Param in_that

The source ImportNotifier to copy.

ImportNotifier (HPS.IONotifier in_that)

The conversion constructor creates a new derived ImportNotifier object from a base IONotifier object. The copy will only be successful if the source notifier is really an upcast of this notifier type. Otherwise the copy will fail and the resulting ImportNotifier will be invalid.

Param in_that

The source IONotifier 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.

class ImportOptionsKit : public HPS.SprocketKit

The HPS.Exchange.ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via Exchange. Calling HPS.Exchange.ImportOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ImportOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ImportOptionsKit in_kit)

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Param in_kit

The source ImportOptionsKit to compare to this ImportOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

ImportOptionsKit ()

The default constructor creates an empty ImportOptionsKit object.

ImportOptionsKit (HPS.Exchange.ImportOptionsKit in_kit)

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

Param in_kit

The source ImportOptionsKit 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.Exchange.ImportOptionsKit in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Param in_kit

The source ImportOptionsKit to copy.

HPS.Exchange.ImportOptionsKit SetActiveFilter (bool in_state)

Sets whether to only import data from the active filter in the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadActiveFilter.

See

Default value

Param in_state

Whether to only import data from the active filter in the CAD file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetAnnotationCaptureFitting (HPS.Exchange.AnnotationCaptureFitting in_fitting)

Sets the type of data that should be used to generate the camera for annotation captures.

Param in_fitting

The type of fitting to use for annotation captures.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetAttributes (bool in_state)

Sets whether to import attributes (or metadata) from the CAD file. Even if attributes are not imported, some things like names and certain IDs will be available, though all other attributes will not be. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadAttributes.

See

Default value

Param in_state

Whether to import attributes from the CAD file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetBRepMode (HPS.Exchange.BRepMode in_mode)

Sets the import mode for BRep data in the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_eReadGeomTessMode.

See

Default value

Param in_mode

The import mode for BRep data in the CAD file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetCatiaV4LogicalNameForRootDirectory (string in_name)

Sets the logical name for the root directory for a Catia V4 file. This corresponds to the value that will be passed to A3DRWParamsCatiaV4Data::m_pcRootDirLogicalName.

See

Default value

Param in_name

UTF8-encoded logical name for the root directory for a Catia V4 file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetCatiaV4LogicalNameSearching (bool in_state)

Sets the whether to allow searching in additional logical names for a Catia V4 file. This corresponds to the value that will be passed to A3DRWParamsCatiaV4Data::m_bAllowSearchInOtherLogicalNames.

See

SetSearchDirectories

See

Default value

Param in_state

Whether to allow searching in addtional logical names for a Catia V4 file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetCatiaV5Cache (bool in_active, string in_path)

Sets whether to use the a cache for a Catia V5 file.

See

Default value

Param in_active

Whether the cache should be activated for a Catia V5 file. This corresponds to the value that will be passed to A3DRWParamsCatiaV5Data::m_bCacheActivation.

Param in_path

UTF8-encoded path to the folder to be used for the Catia V5 cache. This corresponds to the value that will be passed to and A3DRWParamsCatiaV5Data::m_pcCachePath.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetCatiaV5MaterialRendering (bool in_active)

Sets whether to use material for rendering for a Catia V5 file. The path to search for the materials needs to be specified through ImportOptionsKit.SetTextureDirectories.

See

Default value

Param in_active

Whether to use materials for rendering for a Catia V5 file. This corresponds to the value that will be passed to A3DRWParamsCatiaV5Data::m_bUseMaterialRendering.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetComputePreferredOpenShellOrientation (bool in_state)

This option lets you redirect the normal of non-solid bodies. eg: when a body is not able to be sewed closed it still has the notion of an inside and outside. the in_state will be passed to A3DSewOptionsData With this option, you are asking Exchange to use a predictive algorithm to correctly identify inside vs outside.

Param in_state

The state of the option used when importing a file

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetConfiguration (string in_configuration)

Sets the configuration to import from a CAD file. This is only applicable to Catia V4, Solidworks and I-deas file formats. If no configuration is specified, the default configuration will be loaded if possible. This corresponds to the value that will be passed to A3DRWParamsMultiEntriesData::m_ppcEntries.

Param in_configuration

UTF8-encoded configuration name to import from a CAD file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetConfiguration (string[] in_configuration)

Sets a nested configuration to import from a CAD file. This is only applicable to Catia V4, Solidworks and I-deas file formats. If no configuration is specified, the default configuration will be loaded if possible. These correspond to the values that will be passed to A3DRWParamsMultiEntriesData::m_ppcEntries.

Param in_configuration

List of nested configuration names to import from a CAD file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetConstraintsInfo (bool in_state)

Sets whether to import constraints from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadConstraints. Furthermore, assembly constraints are only supported in files of the following formats: CatiaV5.

See

Default value

Param in_state

Whether to import constraints info from the CAD file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetConstructionAndReferences (bool in_state)

Sets whether to import construction and references from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadConstructionAndReferences.

See

Default value

Param in_state

Whether to import construction and references from the CAD file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetDefaultUnits (HPS.Exchange.Units in_units)

Sets the units to use for a CAD file if it is not well defined. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_eDefaultUnit.

See

Default value

Param in_units

The units to use for the CAD file if it is not well defined.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetDrawings (bool in_state)

Sets whether to import drawings from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_eReadDrawings.

See

Default value

Param in_state

Whether to import 2d drawings from the CAD file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetExternalProductOccurrence (bool read_external_po)

Dictates whether Visualize will read the external data Product Occurrence in the PRC.

Note

In the PRC sometime Product Occurrence contains another Product Occurrence in its ExternalData. Normally Visualize will not include this level of Product Occurrence in its model tree, but by activate this we will have this level in the model tree.

Param read_external_po

Whether or not to have Visualize read the Product occurrence of the ExternalData.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetFeatureTrees (bool in_state)

Sets whether to import feature trees from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadFeature. The following Import Options are incompatible with Feature Trees: sewing, importing a file using multiple processes, and using the Incremental import Mode. Furthermore, features are only supported in files of the following formats: CatiaV5, NX (also known as Unigraphics) and ProE (also known as Creo).

See

Default value

Param in_state

Whether to import feature trees from the CAD file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetGeometryDefaultColor (HPS.RGBAColor in_color)

Sets the color to use for non-PMI geometry in the CAD file if none is specified.

See

SetPMIDefaultColor

Param in_color

The color to use for non-PMI geometry in the CAD file if none is specified.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetHiddenObjects (bool in_state)

Sets whether to import hidden objects from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadHiddenObjects.

See

Default value

Param in_state

Whether to import hidden objects from the CAD file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetIFCAttributeXMLFile (string in_filename)

Sets the file to write attribute data to in XML format for an IFC file. This corresponds to the value that will be passed to A3DRWParamsIFCData::m_pcXMLFilePathForAttributes.

See

SetAttributes

See

Default value

Param in_filename

UTF8-encoded filename for attribute data.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetIFCCodePageName (string in_name)

Sets the code page name for an IFC file. This corresponds to the value that will be passed to A3DRWParamsIFCData::m_pcCodePageName.

See

Default value

Param in_name

UTF8-encoded code page name for an IFC file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit 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.

See

Default value

Param in_state

Whether to import edges for an IFC file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetIFCFaceOptimization (bool in_state)

Sets whether to optimize importing of faces. Setting this to true will reduce the number of polyhedra generated during the import. This corresponds to the value that will be passed to A3DRWParamsIFCData::m_bFACETED_BREPAsOnFace.

See

Default value

Param in_state

Whether to optimize face import for an IFC file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetIFCMetadata (bool in_state)

Sets whether to import all IFC metadata or to import only each part’s GloablID. . This corresponds to the value that will be passed to A3DRWParamsIFCData::m_bAttributesOnlyGlobalId.

See

Default value

Param in_state

Whether to import all IFC metadata or to import only each part’s GlobalID

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetIFCOpenings (bool in_state)

Sets whether to import opening elements for IFC files. This corresponds to the value that will be passed to A3DRWParamsIFCData::m_bReadOpeningElements.

See

Default value

Param in_state

Whether to import opening elements for an IFC file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetIFCOwnerHistoryOptimization (bool in_state)

Sets whether to optimize the setting of IFCOWNERHISTORY for an IFC file. This corresponds to the value that will be passed to A3DRWParamsIFCData::m_bIFCOWNERHISTORYOptimized.

See

Default value

Param in_state

Whether to optimize the setting of IFCOWNERHISTORY for an IFC file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetIFCRelationships (bool in_state)

Sets whether to import relationships for IFC files. This corresponds to the value that will be passed to A3DRWParamsIFCData::m_bReadRelationships.

See

Default value

Param in_state

Whether to import relationships for an IFC file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetIncrementalComponentPath (HPS.ComponentPath in_path)

The path to the product occurrence to load. This option should only be used if a file was imported incrementally (i.e., with the SetMode option set to ImportMode.Incremental) and the specified path has not already been loaded, otherwise an exception will be thrown from the ImportNotifier. Note that you can check the load status of a product occurrence by using ProductOccurrence.GetLoadStatus. The leaf of the path should be a product occurrence, though if it is not, the closest product occurrence in the path will be loaded. It is important to note that this option is mutually exclusive with the mode option, i.e., if one is set, the other will be unset.

See

SetMode

See

SetIncrementalComponentPaths

Param in_path

The path to the product occurrence to load.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetIncrementalComponentPaths (HPS.ComponentPath[] in_paths)

The paths to the product occurrences to load. This option has the same behavior and limitations as SetIncrementalPath, but allows one to specify multiple paths to load.

See

SetMode

See

SetIncrementalComponentPath

Param in_paths

The paths to the product occurrences to load.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetInventorEmbeddedTessellation (bool in_state)

Whether to use the tessellation embedded in the file, for Inventor files. This corresponds to the value that will be passed to A3DRWParamsInventorData::m_bUseTessForFile.

Param in_state

Whether to use the tessellation embedded in the file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetJTTessellationLevel (HPS.Exchange.JT.TessellationLevel in_jt_tessellation_level)

Sets the tessellation level to load for JT files. This corresponds to the value that will be passed to A3DRWParamsJTData::m_eReadTessellationLevelOfDetail.

See

Default value

Param in_jt_tessellation_level

The tessellation level to load.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetLargeTranslationExtraction (bool in_state)

When this option is enabled, translations that are deemed to be especially large compared to the model size are removed from the scene graph and instead imported as user data, at the index specified, on the segment where the translation would have been. Removing very large translation is useful to avoid visual artifacts due to loss in precision. Note that only part of a translation might be extracted. If you are adding a model to an existing scene through the SetLocation feature, and the original model was loaded using the SetLargeTranslationExtraction setting, the same data_index value should be used for the model being added to the existing scene, so that any translations previously extracted from the model can be taken into account during import.

See

Default value

Param in_state

Whether to enable large translation extraction

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetLargeTranslationExtraction (bool in_state, IntPtr in_data_index)

When this option is enabled, translations that are deemed to be especially large compared to the model size are removed from the scene graph and instead imported as user data, at the index specified, on the segment where the translation would have been. Removing very large translation is useful to avoid visual artifacts due to loss in precision. Note that only part of a translation might be extracted. If you are adding a model to an existing scene through the SetLocation feature, and the original model was loaded using the SetLargeTranslationExtraction setting, the same data_index value should be used for the model being added to the existing scene, so that any translations previously extracted from the model can be taken into account during import.

See

Default value

Param in_state

Whether to enable large translation extraction

Param in_data_index

The index at which the user data representing the extracted translation will be stored

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetLargeTranslationExtraction (bool in_state, IntPtr in_data_index, float in_cutoff_value)

When this option is enabled, translations that are deemed to be especially large compared to the model size are removed from the scene graph and instead imported as user data, at the index specified, on the segment where the translation would have been. Removing very large translation is useful to avoid visual artifacts due to loss in precision. Note that only part of a translation might be extracted. If you are adding a model to an existing scene through the SetLocation feature, and the original model was loaded using the SetLargeTranslationExtraction setting, the same data_index value should be used for the model being added to the existing scene, so that any translations previously extracted from the model can be taken into account during import.

See

Default value

Param in_state

Whether to enable large translation extraction

Param in_data_index

The index at which the user data representing the extracted translation will be stored

Param in_cutoff_value

The cutoff value which will be used to check for large translation

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetLocation (HPS.ComponentPath in_path)

Sets where to insert the imported file in an existing Component hierarchy. If this option is not set, a new CADModel will be created for the imported file. If this option is specified, the underlying PRC data of the existing CADModel will be modified to include the imported file and the data will be imported into the specified location in the existing Component hierarchy and its corresponding scene graph.

Param in_path

The path describing the location to insert the imported file into. This path must either terminate at a CADModel or a Component corresponding to an A3DAsmProductOccurrence. Note that if the imported file is added along a ComponentPath with attributes specified in the PRC data, the components added to the existing PRC data will also inherit those attributes. Note also that if the path is just a CADModel, a new A3DAsmModelFile underyling the CADModel must be created to include both the existing product occurrences and the new product occurrences, and the existing A3DAsmModelFile will be deleted.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetLocation (HPS.ComponentPath in_path, HPS.MatrixKit in_transform)

Sets where to insert the imported file in an existing Component hierarchy. If this option is not set, a new CADModel will be created for the imported file. If this option is specified, the underlying PRC data of the existing CADModel will be modified to include the imported file and the data will be imported into the specified location in the existing Component hierarchy and its corresponding scene graph.

Param in_path

The path describing the location to insert the imported file into. This path must either terminate at a CADModel or a Component corresponding to an A3DAsmProductOccurrence. Note that if the imported file is added along a ComponentPath with attributes specified in the PRC data, the components added to the existing PRC data will also inherit those attributes. Note also that if the path is just a CADModel, a new A3DAsmModelFile underyling the CADModel must be created to include both the existing product occurrences and the new product occurrences, and the existing A3DAsmModelFile will be deleted.

Param in_transform

A transform to apply to the components being added to the existing CADModel. This transform will also be added to the underlying PRC data. Defaults to an identity transform.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetMode (HPS.Exchange.ImportMode in_mode)

Sets the type of import to perform. If set to ImportMode.Incremental, only the structural components of the CAD file will be created, but the underlying representation items will not be loaded. These empty product occurrence objects can then be loaded by using the SetIncrementalComponentPath or SetIncrementalComponentPaths functions. If set to ImportMode.Complete, the CAD file will be imported respecting the other specified import options. It is important to note that incremental import can only be performed for certain formats (see ImportMode.Incremental for the specific formats). Trying to use incremental import with an unsupported format will cause the import to fail and an exception to be thrown by the ImportNotifier. Also it is important to note that this option is mutually exclusive with the incremental ComponentPath option, i.e., if one is set, the other will be unset.

See

SetIncrementalComponentPath

See

SetIncrementalComponentPaths

Param in_mode

The type of import to perform.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetMultiProcessCount (uint in_count)

Sets the number of processes to use when performing the import. This should be a value between 1 and the number of cores on your system.

Deprecated:

This function has been deprecated.

Note

Values greater than 1 can only be used for imports of certain formats, in particular, JT, SolidWorks, NX (Unigraphics), Creo (Pro/E), and CATIA V5 files.

Param in_count

The number of processes to use when performing the import.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetNURBSConversion (HPS.Exchange.NURBSConversionOptionsKit in_nurbs_conversion_options)

Converts the curves and surfaces of the model file according to the options specified.

Param in_nurbs_conversion_options

The options to use during conversion

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetPDF3DStreamIndex (ulong in_index)

Sets the index into the list 3D streams contained in a PDF to load.

See

Default value

Param in_index

The index into the list of 3D stream contained in a PDF to load.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetPMI (bool in_state)

Sets whether to import PMI from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadPmis.

See

Default value

Param in_state

Whether to import PMI from the CAD file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetPMIDefaultColor (HPS.RGBColor in_color)

Sets the color to use for the PMI in the CAD file if none is specified. This corresponds to the value that will be passed to A3DRWParamsPmiData::m_sDefaultColor. Optionally, it is possible to force all PMI to appear in the specified color. Thie corresponds to the value what will be passed to A3DRWParamsPmiData::m_bAlwaysUseDefaultColor.

See

Default value

Param in_color

The color to use for the PMI in the CAD file if none is specified.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetPMIDefaultColor (HPS.RGBColor in_color, bool in_override_color)

Sets the color to use for the PMI in the CAD file if none is specified. This corresponds to the value that will be passed to A3DRWParamsPmiData::m_sDefaultColor. Optionally, it is possible to force all PMI to appear in the specified color. Thie corresponds to the value what will be passed to A3DRWParamsPmiData::m_bAlwaysUseDefaultColor.

See

Default value

Param in_color

The color to use for the PMI in the CAD file if none is specified.

Param in_override_color

Whether to force all PMIs to use the color specified by in_color.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetPMIDefaultUnits (HPS.Exchange.Units in_units)

Sets the units to use for the PMI in the CAD file if it is not well defined. This corresponds to the value that will be passed to A3DRWParamsPmiData::m_eDefaultUnit.

See

Default value

Param in_units

The units to use for the PMI in the CAD file if it is not well defined.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetPMIFlipping (bool in_flip)

Dictates whether Visualize will flip pmi when rotating so that text / symbols remain readable.

Note

If exchange reports that a markup does not contain leader lines, but the tessellation does contain lines that markup will not be flipped. This is a precaution for models where the leader line geometry was included as part of the markup tessellation and flipping the geometry would cause any present leader lines to point in the wrong direction.

Param in_flip

Whether or not to have Visualize flip pmi when rotating.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetPMIPrecision (ulong in_precision)

Sets the precision to use for PMI which has no precision information in the CAD file. This corresponds to the value that will be passed to A3DRWParamsPmiData::m_iNumberOfDigitsAfterDot.

See

Default value

Param in_precision

The precision to use for PMI which has no precision information in the CAD file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetPMISubstitutionFont (string in_font_name)

Sets the font to use to replace those referenced by the CAD file but which are not present on the system.

Param in_font_name

UTF8-encoded name of the font to use to replaced those referenced by the CAD file but which are not present on the system. This corresponds to the value that will be passed to A3DRWParamsPmiData::m_pcSubstitutionFont.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetPMISubstitutionFont (string in_font_name, bool in_always_substitute)

Sets the font to use to replace those referenced by the CAD file but which are not present on the system.

Param in_font_name

UTF8-encoded name of the font to use to replaced those referenced by the CAD file but which are not present on the system. This corresponds to the value that will be passed to A3DRWParamsPmiData::m_pcSubstitutionFont.

Param in_always_substitute

Whether to always use this font even in place of those which are present on the system. This corresponds to the value that will be passed to A3DRWParamsPmiData::m_bAlwaysSubstituteFont.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetPRCReadHelper (bool in_use_helper)

Sets whether to create an A3DRWParamsPrcReadHelper when importing a PRC file or a PRC stream. The resulting A3DRWParamsPrcReadHelper can be accessed by Exchange.ImportNotifier.GetPRCReadHelper.

See

Exchange.ImportNotifier.GetPRCReadHelper

Param in_use_helper

Whether to create an A3DRWParamsPrcReadHelper during import.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetProECodePageName (string in_name)

Sets the code page name for a Pro/E file. This corresponds to the value that will be passed to A3DRWParamsProEData::m_pcCodePageName.

See

Default value

Param in_name

UTF8-encoded code page name for a Pro/E file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetProEConstructionEntities (HPS.Exchange.ProE.ConstructionEntities in_state)

Sets whether to import construction entities for a Pro/E file This corresponds to the value that will be passed to A3DRWParamsProEData::m_eReadConstrucEntities.

See

Default value

Param in_state

Whether to import construction entities for a Pro/E file

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetProEDatum (bool in_source)

Sets whether datums are visible, for a Pro/E file This corresponds to the value that will be passed to A3DRWParamsProEData::m_bDisplayVisibleDatum.

See

Default value

Param in_source

Whether visible datums are visible for a Pro/E file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetProEDimensionTolerance (bool in_state)

Sets whether to import dimension tolerances for a Pro/E file. This corresponds to the value that will be passed to A3DRWParamsProEData::m_bDisplayTolerance.

See

Default value

Param in_state

Whether to import dimension tolerances for a Pro/E file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetProEExplodedViews (bool in_source)

Sets whether to create additional Views for a Pro/E file, with each view representing an explode state. This corresponds to the value that will be passed to A3DRWParamsProEData::m_bReadExplodeStateAsView.

See

Default value

Param in_source

Whether to create a views for exploded states, for a Pro/E file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetProEFamilyTableSource (HPS.Exchange.ProE.FamilyTable in_source)

Sets the source for Family Tables for a Pro/E file This corresponds to the value that will be passed to A3DRWParamsProEData::m_eFamilyTables.

See

Default value

Param in_source

Sets the family tables source for a Pro/E file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetProEHomeView (bool in_source)

Sets whether to create an additional Home View for a Pro/E file. This view will reflect the state in which the file was saved. This corresponds to the value that will be passed to A3DRWParamsProEData::m_bComputeHomeView.

See

Default value

Param in_source

Whether to create a home view for a Pro/E file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetProEMissingBoolean (bool in_state)

Sets whether to import the entities making up a boolean operation for a Pro/E file, in the case where the tessellation for the result of this boolean operation cannot be found. This corresponds to the value that will be passed to A3DRWParamsProEData::m_bBoolOpUseGenericIfNoTess.

See

Default value

Param in_state

Whether to import the entities of a boolean operation for which there is no available tessellation for a Pro/E file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetProEMissingFlexibleComponent (bool in_state)

Sets whether to try to import a flexible component for a Pro/E file, even in the case where the tessellation for the component cannot be found. This corresponds to the value that will be passed to A3DRWParamsProEData::m_bFlexCompUseGenericIfNoTess.

See

Default value

Param in_state

Whether to always try to import a flexible component, even in the event of missing tessellation, for a Pro/E file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetProESessionColor (HPS.Exchange.ProE.SessionColor in_type)

Sets the session color for a Pro/E file. This corresponds to the value that will be passed to A3DRWParamsProEData::m_eSessionColorType.

See

Default value

Param in_type

The session color for a Pro/E file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetProESkeletons (bool in_state)

Sets whether to import skeleton entities for a Pro/E file. This corresponds to the inverse value that will be passed to A3DRWParamsProEData::m_bHideSkeletons.

See

Default value

Param in_state

Whether import skeleton entities for a Pro/E file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetProESubpartPMI (bool in_state)

Sets whether to import subpart PMI for a Pro/E file. This corresponds to the value that will be passed to A3DRWParamsProEData::m_bDisplaySubpartAnnotations.

See

Default value

Param in_state

Whether to import subpart PMI for a Pro/E file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetRemovedViews (bool read_removed_views)

Dictates whether Visualize will read the views in the PRC that have kA3DGraphicsRemoved bit set.

Note

In the PRC sometime views in subassemblies or Part of the model file are marked with kA3DGraphicsRemoved bit. These views still exist in the PRC, however normally are ignored by viewer.

Param read_removed_views

Whether or not to have Visualize read the removed views in PRC.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetRevitPhysicalProperties (HPS.Exchange.Revit.PhysicalProperties in_physical_properties)

Sets how physical properties are imported. By default, no physical property is imported. This setting also will only be taken into account only if we choose to import attributes from the model. This corresponds to the value that will be passed to A3DRWParamsRevitData::m_ePhysicalProperties.

Param in_physical_properties

Physical properties setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetRhinoForceRenderedModeColors (bool in_state)

Rhino files can be viewed in either ‘shaded’ mode or ‘render’ mode. By default the shaded mode colors will be imported. This function allows you to import render model colors instead. This corresponds to the value that will be passed to A3DRWParamsRhinoData::m_bForceRenderedModeColors.

Param in_state

Whether to force rendered mode colors instead of shading mode colors.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetSearchDirectories (string[] in_directories, bool[] in_recurse_flags)

Sets the directories to search to find files referenced by a CAD assembly. If no search directories are set, the directory containing the CAD assembly will be searched recursively. If the size of the directory and flag arrays are different, the smaller size will be used. These correspond to the values that will be passed to A3DRWParamsAssemblyData::m_ppcSearchDirectories.

Param in_directories

The directories to search for files references by a CAD assembly.

Param in_recurse_flags

Whether to search recursively in each of the corresponding directories.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetSearchDirectories (string[] in_directories, string[] in_logical_names, bool[] in_recurse_flags)

Sets the directories to search to find files referenced by a CAD assembly. This variant additionally allows the specification of logical names for each search directory for use by Catia V4 files. If no search directories are set, the directory containing the CAD assembly will be searched recursively. If the size of the directory, (non-empty) logical name, or flag arrays are different, the smallest size will be used. These correspond to the values that will be passed to A3DRWParamsAssemblyData::m_ppcSearchDirectories.

See

SetCatiaV4LogicalNameSearching

Param in_directories

The directories to search for files references by a CAD assembly.

Param in_logical_names

The logical names for each corresponding directory. If there are no logical names for the directories, this array can be empty.

Param in_recurse_flags

Whether to search recursively in each of the corresponding directories.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetSearchDirectoriesByFile (string[] in_file_names)

Sets the directories to search to find files referenced by a CAD assembly. This is an alternative manner to specify search directories by using text files which contain lists of directories to search. These correspond to the values will be passed to A3DRWParamsAssemblyData::m_ppcPathDefinitions.

Param in_file_names

The names of text files containing the lists of directories to search to find files referenced by a CAD assembly.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetSearchRootDirectory (bool in_state)

Sets whether to search the CAD file root directory for sub-parts. The values passed to this function correspond to A3DRWParamsAssemblyData::m_bUseRootDirectory and A3DRWParamsAssemblyData::m_bRootDirRecursive respectively.

Param in_state

Whether to search the root CAD file directory for sub-parts

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetSearchRootDirectory (bool in_state, bool in_recursive)

Sets whether to search the CAD file root directory for sub-parts. The values passed to this function correspond to A3DRWParamsAssemblyData::m_bUseRootDirectory and A3DRWParamsAssemblyData::m_bRootDirRecursive respectively.

Param in_state

Whether to search the root CAD file directory for sub-parts

Param in_recursive

Whether to search subdirectories of the root directory for sub-parts. This option is only considered if in_state is true, and the subdirectories are only searched if the sub-parts are not found in the root directory.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetSewingTolerance (double in_tolerance)

The sewing tolerance to use on the A3DAsmModelFile after importing a file. If this option is set, after a file is successfully imported, the A3DAsmModelFile will be passed to A3DAsmModelFileSew with this tolerance.

Param in_tolerance

The sewing tolerance in millimeters to use on the A3DAsmModelFile after importing a file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetSolids (bool in_state)

Sets whether to import solids from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadSolids.

See

Default value

Param in_state

Whether to import solids from the CAD file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetSolidworksDisplayVisibleDatum (bool in_state)

Manage the visibility of datum entities: if set to 0, visibility is hidden if set to 1, visibility is as in SLW feature tree manager This corresponds to the value that will be passed to A3DRWParamsSolidworksData::m_usDisplayVisibleDatum.

Param in_state

Whether to use the visibility defined in the file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetSTEPCodePageName (string in_name)

Sets the code page name for a STEP file. This corresponds to the value that will be passed to A3DRWParamsStepData::m_pcCodePageName

See

Default value

Param in_name

UTF8-encoded code page name for a STEP file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetSTEPFirstColorPreference (bool in_state)

Sets whether to prefer the first color if geometry has several colors for a STEP file. This corresponds to the value that will be passed to A3DRWParamsStepData::m_bPreferFirstColor.

See

Default value

Param in_state

Whether to prefer the first color if geometry has several colors for a STEP file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetSTEPNamePreference (HPS.Exchange.STEP.Field in_field)

Sets the field to get the occurrence name from for a STEP file. These correspond to the value that will be passed to A3DRWParamsStepData::m_bPreferProductName and A3DRWParamsStepData::m_eNameFromNAUO.

See

Default value

Param in_field

The field to get the occurrence name from for a STEP file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetSTEPOrientationHealing (bool in_state)

Sets whether to heal orientations for a STEP file. This corresponds to the value that will be passed to A3DRWParamsStepData::m_bHealOrientations.

See

Default value

Param in_state

Whether to heal orientations for a STEP file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetSTEPShellBasedSurfaceModelSplitting (bool in_state)

Sets whether to split SHELL_BASED_SURFACE_MODEL with several OPEN_SHELLs into several bodies for a STEP file. This corresponds to the value that will be passed to A3DRWParamsStepData::m_bSplitSHELL_BASED_SURFACE_MODEL.

See

Default value

Param in_state

Whether to split SHELL_BASED_SURFACE_MODEL with several OPEN_SHELLs into several bodies for a STEP file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetSTEPValidationProperties (bool in_state)

Sets whether to import validation properties for a STEP file. This corresponds to the value that will be passed to A3DRWParamsStepData::m_bReadValidationProperties. This option is valid only if Attributes are being imported.

Param in_state

Whether to import validation properties for a STEP file.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetSurfaces (bool in_state)

Sets whether to import surfaces from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadSurfaces.

See

Default value

Param in_state

Whether to import surfaces from the CAD file.

Return

A reference to this ImportOptionsKit.

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

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

See

Default value

Param in_type

The accuracy to use for tessellation generation.

Return

A reference to this ImportOptionsKit.

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

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

See

Default value

Param in_type

The accuracy to use for tessellation generation.

Param in_accurate_normals

Whether to compute surface normals when performing accurate tessellation. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.Accuracy.GridAccurate. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation.

Return

A reference to this ImportOptionsKit.

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

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

See

Default value

Param in_type

The accuracy to use for tessellation generation.

Param in_accurate_normals

Whether to compute surface normals when performing accurate tessellation. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.Accuracy.GridAccurate. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation.

Param in_accurate_surface_curvatures

Whether to take into account surfaces curvature in accurate tessellation to controle triangles elongation directions. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.Accuracy.GridAccurate. This correspond to the value that will be passed to A3DRWParamsTessellationData::m_bAccurateSurfaceCurvatures.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetTessellationAccuracy (HPS.Exchange.Tessellation.Accuracy in_type, bool in_accurate_normals, bool in_accurate_surface_curvatures, double in_accurate_grid_maximum_stitch_length)

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

See

Default value

Param in_type

The accuracy to use for tessellation generation.

Param in_accurate_normals

Whether to compute surface normals when performing accurate tessellation. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.Accuracy.GridAccurate. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation.

Param in_accurate_surface_curvatures

Whether to take into account surfaces curvature in accurate tessellation to controle triangles elongation directions. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.Accuracy.GridAccurate. This correspond to the value that will be passed to A3DRWParamsTessellationData::m_bAccurateSurfaceCurvatures.

Param in_accurate_grid_maximum_stitch_length

Maximal grid stitch length. Disabled if value is 0. Be careful, a too small value can generate a huge tessellation. This only applies if in_type is set to Tessellation.Accuracy.GridAccurate. This correspond to the value that will be passed to A3DRWParamsTessellationData::m_dAccurateTessellationWithGridMaximumStitchLength.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetTessellationCleanup (bool in_cleanup)

Dictates whether Exchange tesselation data will be released from their parent representation items during import.

Warning

Setting this option to true will cause future exports to output without tessellation data.

Param in_cleanup

Whether to clean up tessellation data from representation items.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit 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 A3DRWParamsTessellationData::m_eTessellationLevel to kA3DTessLODUserDefined.

Param in_limit_type

The type of the chord limit to be specified.

Param in_limit

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

Param in_angle_tolerance

The 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 A3DRWParamsTessellationData::m_dAngleToleranceDeg.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit 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 A3DRWParamsTessellationData::m_eTessellationLevelOfDetail.

See

Default value

Param in_level

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

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit 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 A3DRWParamsTessellationData::m_dMaximalTriangleEdgeLength.

See

Default value

Param in_length

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

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit 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 A3DRWParamsTessellationData::m_bKeepUVPoints.

See

Default value

Param in_state

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

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetTextureDirectories (string[] in_directories)

Sets the directories to search to find textures referenced by a CAD assembly. If no search directories are set, the directory containing the CAD assembly will be searched recursively. These correspond to the values that will be passed to A3DRWParamsGeneralData::m_ppcSearchTextureDirectories.

Param in_directories

The directories to search for textures referenced by a CAD assembly.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetTrueColorMode (bool in_true_color)

Sets whether we use the true color coming from the software for model rendering.

See

Default value

Param in_true_color

Whether to use the exact RGB color value coming from the software. True: The exact RGB value from the diffuse channel is used to color the face. This is useful if you want to have exact value from the native software. Note: the color from the ambient channel will not be honored and some models may look different. False: Default mode. HOOPS Visualize uses ambient and diffuse channel to have a good looking material. The rendering color matches the model but the RGB value may differ slightly from the native model.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetUnigraphicsFittedCamera (bool in_state)

Sets whether to make view cameras fitted for a Unigraphics file.

See

Default value

Param in_state

Whether to make view cameras fit all visible geometry for a Unigraphics file. This corresponds to the value that will be passed to A3DRWParamsUnigraphicsData::m_bFitAllToUpdateViewCameras.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetUnigraphicsPreferredReferenceSets (string[] in_reference_sets, bool in_apply_to_all_levels)

Sets the preferred reference sets for a Unigraphics file.

See

Default value

Param in_reference_sets

List of preferred references sets for a Unigraphics file. This corresponds to the value that will be passed to A3DRWParamsUnigraphicsData::m_ppcPreferredReferenceSets.

Param in_apply_to_all_levels

Whether the reference sets will apply to subassemblies for a Unigraphics file. This corresponds to the value that will be passed to A3DRWParamsUnigraphicsData::m_bApplyToAllLevels.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit SetWireframes (bool in_state)

Sets whether to import wireframes from the CAD file. This corresponds to the value that will be passed to A3DRWParamsGeneralData::m_bReadWireframes.

See

Default value

Param in_state

Whether to import wireframes from the CAD file.

Return

A reference to this ImportOptionsKit.

void Show (out HPS.Exchange.ImportOptionsKit out_kit)

Copies this ImportOptionsKit into the given ImportOptionsKit.

Param out_kit

The ImportOptionsKit to populate with the contents of this ImportOptionsKit.

bool ShowActiveFilter (out bool out_state)

Shows the active filter import setting.

Param out_state

Whether to only import data from the active filter in the CAD file.

Return

true if an active filter import setting was specified, false otherwise.

bool ShowAnnotationCaptureFitting (out HPS.Exchange.AnnotationCaptureFitting out_fitting)

Shows the annotation capture fitting setting.

Param out_fitting

The type of fitting to use for annotation captures.

Return

true if an annotation capture fitting setting was specified, false otherwise.

bool ShowAttributes (out bool out_state)

Shows the attribute import setting.

Param out_state

Whether to import attributes from the CAD file.

Return

true if an attribute import setting was specified, false otherwise.

bool ShowBRepMode (out HPS.Exchange.BRepMode out_mode)

Shows the BRep mode import setting.

Param out_mode

The import mode for BRep data in the CAD file.

Return

true if a BRep mode import setting was specified, false otherwise.

bool ShowCatiaV4LogicalNameForRootDirectory (out string out_name)

Shows the Catia V4 logical name for the root directory.

Param out_name

The Catia V4 logical name for the root directory.

Return

true if a Catia V4 logical name for the root directory setting was specified, false otherwise.

bool ShowCatiaV4LogicalNameSearching (out bool out_state)

Shows the Catia V4 logical name searching setting.

Param out_state

Whether to allow searching in addtional logical names for a Catia V4 file.

Return

true if a Catia V4 logical name searching setting was specified, false otherwise.

bool ShowCatiaV5Cache (out bool out_active, out string out_path)

Shows the Catia V5 cache setting.

Param out_active

Whether the cache should be activated for a Catia V5 file.

Param out_path

The path to the folder to be used for the Catia V5 cache.

Return

true if a Catia V5 cache setting was specified, false otherwise.

bool ShowCatiaV5MaterialRendering (out bool out_active)

Shows the Catia V5 material rendering setting.

Param out_active

Whether the option material rendering should be activated for a Catia V5 file.

Return

true if a Catia V5 material rendering setting was specified, false otherwise.

bool ShowComputePreferredOpenShellOrientation (out bool out_state)

Shows the compute preferred open shell orientation setting.

Param out_state

The compute preferred open shell orientation to use in the A3DSewOptionsData structure when importing a file.

Return

true if compute preferred open shell orientation setting was specified, false otherwise.

bool ShowConfiguration (out string[] out_configuration)

bool ShowConstraintsInfo (out bool out_state)

Shows the constraints import setting.

Param out_state

Whether to import constraints info from the CAD file.

Return

true if a constraints info import setting was specified, false otherwise.

bool ShowConstructionAndReferences (out bool out_state)

Shows the construction and references import setting.

Param out_state

Whether to import construction and references from the CAD file.

Return

true if a construction and references import setting was specified, false otherwise.

bool ShowDefaultUnits (out HPS.Exchange.Units out_units)

Shows the default units setting.

Param out_units

The default units setting.

Return

true if a default units setting was specified, false otherwise.

bool ShowDrawings (out bool out_state)

Shows the drawings import setting.

Param out_state

Whether to import 2d drawings from the CAD file.

Return

true if a drawings import setting was specified, false otherwise.

bool ShowExternalProductOccurrence (out bool out_read_external_po)

Shows the read external data Product Occurrence setting.

Param out_read_external_po

The read external data Product Occurrence setting that was specified.

Return

true if a read external data Product Occurrence setting was specified, false otherwise.

bool ShowFeatureTrees (out bool out_state)

Shows the feature trees import setting.

Param out_state

Whether to import feature trees from the CAD file.

Return

true if a feature trees import setting was specified, false otherwise.

bool ShowGeometryDefaultColor (out HPS.RGBAColor out_color)

Shows the geometry default color setting.

Param out_color

The geometry default color setting.

Return

true if a geometry default color setting was specified, false otherwise.

bool ShowHiddenObjects (out bool out_state)

Shows the hidden objects import setting.

Param out_state

Whether to import hidden objects from the CAD file.

Return

true if a hidden objects import setting was specified, false otherwise.

bool ShowIFCAttributeXMLFile (out string out_filename)

Shows the IFC attribute XML file setting.

Param out_filename

The filename for attribute data for an IFC file.

Return

true if an IFC attribute XML file setting was specified, false otherwise.

bool ShowIFCCodePageName (out string out_name)

Shows the IFC code page name setting.

Param out_name

The code page name for an IFC file.

Return

true if an IFC code page name setting was specified, false otherwise.

bool ShowIFCEdges (out bool out_state)

Shows the IFC edges setting.

Param out_state

Whether to import edges for an IFC file.

Return

true if an IFC edge setting was specified, false otherwise.

bool ShowIFCFaceOptimization (out bool out_state)

Shows the IFC face optimization setting.

Param out_state

Whether to optimize face import for an IFC file.

Return

true if an IFC face optimization setting was specified, false otherwise.

bool ShowIFCMetadata (out bool out_state)

Shows the IFC metadata setting.

Param out_state

Whether to import all IFC metadata or just each part’s GloablID

Return

true if an IFC metadata setting was specified, false otherwise.

bool ShowIFCOpenings (out bool out_state)

Shows the IFC openings setting.

Param out_state

Whether to import openings for an IFC file.

Return

true if an IFC openings setting was specified, false otherwise.

bool ShowIFCOwnerHistoryOptimization (out bool out_state)

Shows the IFC owner history optimization setting.

Param out_state

Whether to optimize the setting of IFCOWNERHISTORY for an IFC file.

Return

true if an IFC owner history optimization setting was specified, false otherwise.

bool ShowIFCRelationships (out bool out_state)

Shows the IFC relationships setting.

Param out_state

Whether to import relationships for an IFC file.

Return

true if an IFC relationships setting was specified, false otherwise.

bool ShowIncrementalComponentPaths (out HPS.ComponentPath[] out_paths)

Shows the incremental ComponentPaths setting.

Param out_paths

The paths to the product occurrences to load.

Return

true if an incremental ComponentPaths setting was specified, false otherwise.

bool ShowInventorEmbeddedTessellation (out bool out_state)

Shows the Inventor embedded tessellation setting.

Param out_state

The embedded tessellation setting for Inventor files.

Return

true if an Inventor embedded tessellation setting was specified, false otherwise.

bool ShowJTTessellationLevel (out HPS.Exchange.JT.TessellationLevel out_tessellation_level)

Shows the JT tessellation level setting.

Param out_tessellation_level

The tessellation level used when loading the JT file

Return

true if a JT tessellation level setting was specified, false otherwise.

bool ShowLargeTranslationExtraction (out bool out_state, out IntPtr out_data_index, out float out_cutoff_value)

Shows the large translation extraction setting.

Param out_state

Whether to extract large translations during an import.

Param out_data_index

The index at which the user data representing the extracted translation will be stored

Param out_cutoff_value

The cutoff value that was used to check for large translation

Return

true if a large translation extraction setting was specified, false otherwise.

bool ShowLocation (out HPS.ComponentPath out_path, out HPS.MatrixKit out_transform)

Shows the location setting.

Param out_path

The path describing the location to insert the imported file into.

Param out_transform

The transform to apply to the components being added to the existing CADModel.

Return

true if a location setting was specified, false otherwise.

bool ShowMode (out HPS.Exchange.ImportMode out_mode)

Shows the mode setting.

Param out_mode

The type of import to perform.

Return

true if a mode setting was specified, false otherwise.

bool ShowMultiProcessCount (out uint out_count)

Shows the multi-process count setting.

Param out_count

The number of processes to use when performing the import.

Return

true if a multi-process count setting was specified, false otherwise.

bool ShowNURBSConversion (out HPS.Exchange.NURBSConversionOptionsKit out_nurbs_conversion_options)

Shows the NURBS conversion setting.

Param out_nurbs_conversion_options

The options to be used during the conversion.

Return

true if NURBS conversion setting was specified, false otherwise.

bool ShowPDF3DStreamIndex (out ulong out_index)

Shows the PDF 3D stream index setting.

Param out_index

The index into the list of 3D stream contained in a PDF to load.

Return

true if a PDF 3D stream index setting was specified, false otherwise.

bool ShowPMI (out bool out_state)

Shows the PMI import setting.

Param out_state

Whether to import PMI from the CAD file.

Return

true if a PMI import setting was specified, false otherwise.

bool ShowPMIDefaultColor (out HPS.RGBColor out_color, out bool out_override)

Shows the PMI default color setting.

Param out_color

The PMI default color setting.

Param out_override

Whether out_color overrides all PMI color

Return

true if a PMI default color setting was specified, false otherwise.

bool ShowPMIDefaultUnits (out HPS.Exchange.Units out_units)

Shows the PMI default units setting.

Param out_units

The PMI default units setting.

Return

true if a PMI default units setting was specified, false otherwise.

bool ShowPMIFlipping (out bool out_pmi_flipping)

Shows the pmi flipping setting.

Param out_pmi_flipping

The pmi flipping setting that was specified.

Return

true if a pmi flipping setting was specified, false otherwise.

bool ShowPMIPrecision (out ulong out_precision)

Shows the PMI precision setting.

Param out_precision

The precision to use for PMI which has no precision information in the CAD file.

Return

true if a PMI precision setting was specified, false otherwise.

bool ShowPMISubstitutionFont (out string out_font_name, out bool out_always_substitute)

Shows the PMI substitution font setting.

Param out_font_name

UTF8-encoded name of the font to use to replaced those referenced by the CAD file but which are not present on the system.

Param out_always_substitute

Whether to always use this font even in place of those which are present on the system.

Return

true if a PMI substitution font setting was specified, false otherwise.

bool ShowPRCReadHelper (out bool out_use_helper)

Shows the PRC read helper setting.

Param out_use_helper

Whether to create an A3DRWParamsPrcReadHelper during import.

Return

true if a PRC read helper setting was specified, false otherwise.

bool ShowProECodePageName (out string out_name)

Shows the Pro/E code page name setting.

Param out_name

The code page name for a Pro/E file.

Return

true if a Pro/E code page name setting was specified, false otherwise.

bool ShowProEConstructionEntities (out HPS.Exchange.ProE.ConstructionEntities out_state)

Shows the Pro/E construction entities setting.

Param out_state

How to import construction entities, for a Pro/E file.

Return

true if a Pro/E construction entities setting was specified, false otherwise.

bool ShowProEDatum (out bool out_state)

Shows the Pro/E datum setting.

Param out_state

Whether datums are visible, for a Pro/E file.

Return

true if a Pro/E datum setting was specified, false otherwise.

bool ShowProEDimensionTolerance (out bool out_state)

Shows the Pro/E dimension tolerance setting.

Param out_state

Whether to import dimension tolerances for a Pro/E file.

Return

true if a Pro/E dimension tolerance setting was specified, false otherwise.

bool ShowProEExplodedViews (out bool out_state)

Shows the Pro/E exploded views setting.

Param out_state

Whether to create one view for each exploded state, for a Pro/E file.

Return

true if a Pro/E exploded views setting was specified, false otherwise.

bool ShowProEFamilyTableSource (out HPS.Exchange.ProE.FamilyTable out_source)

Shows the Pro/E family table setting.

Param out_source

How to import family tables, for a Pro/E file.

Return

true if a Pro/E family table setting was specified, false otherwise.

bool ShowProEHomeView (out bool out_state)

Shows the Pro/E home view setting.

Param out_state

Whether to create a home view, for a Pro/E file.

Return

true if a Pro/E home view setting was specified, false otherwise.

bool ShowProEMissingBoolean (out bool out_state)

Shows the Pro/E missing boolean setting.

Param out_state

Whether to import boolean entities when their tessellation is missing, for a Pro/E file.

Return

true if a Pro/E missing boolean setting was specified, false otherwise.

bool ShowProEMissingFlexibleComponent (out bool out_state)

Shows the Pro/E missing flexible setting.

Param out_state

Whether to import flexible entities when their tessellation is missing, for a Pro/E file.

Return

true if a Pro/E missing flexible setting was specified, false otherwise.

bool ShowProESessionColor (out HPS.Exchange.ProE.SessionColor out_type)

Shows the Pro/E session color setting.

Param out_type

The session color for a Pro/E file.

Return

true if a Pro/E session color setting was specified, false otherwise.

bool ShowProESkeletons (out bool out_state)

Shows the Pro/E skeletons setting.

Param out_state

Whether to import skeletons, for a Pro/E file.

Return

true if a Pro/E skeletons setting was specified, false otherwise.

bool ShowProESubpartPMI (out bool out_state)

Shows the Pro/E subpart PMI setting.

Param out_state

Whether to import subpart PMI for a Pro/E file.

Return

true if a Pro/E subpart PMI setting was specified, false otherwise.

bool ShowRemovedViews (out bool out_read_removed_views)

Shows the read removed views setting.

Param out_read_removed_views

The read removed views setting that was specified.

Return

true if a read removed views setting was specified, false otherwise.

bool ShowRevitPhysicalProperties (out HPS.Exchange.Revit.PhysicalProperties out_physical_properties)

Shows the Revit physical properties import setting.

Param out_physical_properties

The physical properties import setting for Revit files.

Return

true if a physical properties import setting was specified, false otherwise.

bool ShowRhinoForceRenderedModeColors (out bool out_state)

Shows the Rhino force rendered mode colors setting.

Param out_state

The force rendered mode colors setting for Rhino files.

Return

true if an Rhino embedded force rendered mode colors setting setting was specified, false otherwise.

bool ShowSearchDirectories (out string[] out_directories, out string[] out_logical_names, out bool[] out_recurse_flags)

bool ShowSearchDirectoriesByFile (out string[] out_file_names)

bool ShowSearchRootDirectory (out bool out_state, out bool out_recursive)

Shows the search root directory setting.

Param out_state

Whether to search the CAD file root directory for sub-parts

Param out_recursive

Whether to search subdirectories of the CAD file root directory for sub-parts, if they are not found in the root directory.

Return

true if a root search setting was specified, false otherwise.

bool ShowSewingTolerance (out double out_tolerance)

Shows the sewing tolerance setting.

Param out_tolerance

The sewing tolerance to use on the A3DAsmModelFile after importing a file.

Return

true if a sewing tolerance setting was specified, false otherwise.

bool ShowSolids (out bool out_state)

Shows the solid import setting.

Param out_state

Whether to import solids from the CAD file.

Return

true if a solid import setting was specified, false otherwise.

bool ShowSolidworksDisplayVisibleDatum (out bool out_state)

Shows the Solidworks display visible datum setting.

Param out_state

The display visible datum setting for Solidworks files.

Return

true if an Solidworks display visible datum setting was specified, false otherwise.

bool ShowSTEPCodePageName (out string out_name)

Shows the STEP code page name setting.

Param out_name

The code page name for a STEP file.

Return

true if a STEP code page name setting was specified, false otherwise.

bool ShowSTEPFirstColorPreference (out bool out_state)

Shows the STEP first color preference setting.

Param out_state

Whether to prefer the first color if geometry has several colors for a STEP file.

Return

true if a STEP first color preference setting was specified, false otherwise.

bool ShowSTEPNamePreference (out HPS.Exchange.STEP.Field out_field)

Shows the STEP name preference setting.

Param out_field

The field to get the occurrence name from for a STEP file.

Return

true if a STEP name preference setting was specified, false otherwise.

bool ShowSTEPOrientationHealing (out bool out_state)

Shows the STEP orientation healing setting.

Param out_state

The orientation healing setting for a STEP file.

Return

true if a STEP orientation healing setting was specified, false otherwise.

bool ShowSTEPShellBasedSurfaceModelSplitting (out bool out_state)

Shows the STEP shell based surface model splitting setting.

Param out_state

Whether to split SHELL_BASED_SURFACE_MODEL with several OPEN_SHELLs into several bodies for a STEP file.

Return

true if a STEP shell based surface model splitting setting was specified, false otherwise.

bool ShowSTEPValidationProperties (out bool out_state)

Shows the STEP validation properties setting.

Param out_state

The validation properties setting for a STEP file.

Return

true if a STEP validation property setting was specified, false otherwise.

bool ShowSurfaces (out bool out_state)

Shows the surface import setting.

Param out_state

Whether to import surfaces from the CAD file.

Return

true if a surface import setting was specified, false otherwise.

bool ShowTessellationAccuracy (out HPS.Exchange.Tessellation.Accuracy out_type, out bool out_accurate_normals, out bool out_accurate_surface_curvatures, out double out_accurate_grid_maximum_stitch_length)

Shows the tessellation accuracy setting.

Param out_type

The type of the tessellation accuracy which was specified.

Param out_accurate_normals

Whether to compute surface normals when performing accurate tessellation. This only applies if out_type is different than Tessellation.Accuracy.Standard.

Param out_accurate_surface_curvatures

Whether to take into account surfaces curvature in accurate tessellation to controle triangles elongation directions. This only applies if out_type is different than Tessellation.Accuracy.Standard.

Param out_accurate_grid_maximum_stitch_length

Maximal grid stitch length. Disabled if value is 0. Be careful, a too small value can generate a huge tessellation. This only applies if out_type is Tessellation.Accuracy.GridAccurate.

Return

true if a tessellation accuracy setting was specified, false otherwise.

bool ShowTessellationCleanup (out bool out_cleanup)

Shows the tessellation cleanup setting.

Param out_cleanup

The tesselation cleanup setting that was specified.

Return

true if a tessellation cleanup setting was specified, false otherwise.

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.

Param out_type

The type of the tessellation level setting which was specified.

Param out_level

The predefined quality of the tessellation that will be generated for BRep data. This is only valid if out_type is Tessellation.Type.Standard.

Param out_limit_type

The type of chord limit which was specified. This is only valid if out_type is Tessellation.Type.Custom.

Param out_limit

The 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 Tessellation.Type.Custom.

Param out_angle_tolerance

The maximum angle in degrees between two consecutive wire elements in the generated tessellation. This is only valid if out_type is Tessellation.Type.Custom.

Return

true if a tessellation level setting was specified, false otherwise.

bool ShowTessellationMaximumEdgeLength (out double out_length)

Shows the tessellation maximum edge length setting.

Param out_length

The tessellation maximum edge length setting.

Return

true if a tessellation maximum edge length setting was specified, false otherwise.

bool ShowTessellationPreservesUVPoints (out bool out_state)

Shows the tessellation UV preservation setting.

Param out_state

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

Return

true if a tessellation UV preservation setting was specified, false otherwise.

bool ShowTextureDirectories (out string[] out_directories)

bool ShowTrueColorMode (out bool out_state)

Shows the true color mode setting.

Param out_state

Whether to use the true color mode during an import.

Return

true if a true color mode setting was specified, false otherwise.

bool ShowUnigraphicsFittedCamera (out bool out_state)

Shows the Unigraphics fitted camera setting.

Param out_state

Whether to make view cameras fit all visible geometry for a Unigraphics file.

Return

true if a Unigraphics fitted camera setting was specified, false otherwise.

bool ShowUnigraphicsPreferredReferenceSets (out string[] out_reference_sets, out bool out_apply_to_all_levels)

bool ShowWireframes (out bool out_state)

Shows the wireframe import setting.

Param out_state

Whether to import wireframes from the CAD file.

Return

true if a wireframe import setting was specified, false otherwise.

HPS.Exchange.ImportOptionsKit UnsetActiveFilter ()

Removes the active filter import state.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetAnnotationCaptureFitting ()

Removes the annotation capture fitting setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetAttributes ()

Removes the attribute import state.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetBRepMode ()

Removes the BRep mode import setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetCatiaV4LogicalNameForRootDirectory ()

Removes the Catia V4 logical name for the root directory setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetCatiaV4LogicalNameSearching ()

Removes the Catia V4 logical name searching setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetCatiaV5Cache ()

Removes the Catia V5 cache setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetCatiaV5MaterialRendering ()

Removes the Catia V5 material rendering setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetComputePreferredOpenShellOrientation ()

Removes the compute preferred open shell orientation setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetConfiguration ()

Removes the configuration setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetConstraintsInfo ()

Removes the constraints import state.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetConstructionAndReferences ()

Removes the construction and references import state.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetDefaultUnits ()

Removes the default units setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetDrawings ()

Removes the drawing state.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetEverything ()

Removes all settings from this ImportOptionsKit.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetExternalProductOccurrence ()

Removes the read external data Product Occurrence setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetFeatureTrees ()

Removes the feature trees import state.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetGeometryDefaultColor ()

Removes the geometry default color setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetHiddenObjects ()

Removes the hidden objects import state.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetIFCAttributeXMLFile ()

Removes the IFC attribute XML file setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetIFCCodePageName ()

Removes the IFC code page name setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetIFCEdges ()

Removes the IFC edges setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetIFCFaceOptimization ()

Removes the IFC face optimization setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetIFCMetadata ()

Removes the IFC metadata setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetIFCOpenings ()

Removes the IFC openings setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetIFCOwnerHistoryOptimization ()

Removes the IFC owner history optimization setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetIFCRelationships ()

Removes the IFC relationships setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetIncrementalComponentPaths ()

Removes the incremental ComponentPaths setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetInventorEmbeddedTessellation ()

Removes the Inventor embedded tessellation setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetJTTessellationLevel ()

Removes the JT tessellation level setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetLargeTranslationExtraction ()

Removes the large translation extraction setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetLocation ()

Removes the location setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetMode ()

Removes the mode setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetMultiProcessCount ()

Removes the multi-process count setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetNURBSConversion ()

Removes the NURBS conversion setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetPDF3DStreamIndex ()

Removes the PDF 3D stream index setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetPMI ()

Removes the PMI import state.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetPMIDefaultColor ()

Removes the PMI default color setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetPMIDefaultUnits ()

Removes the PMI default units setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetPMIFlipping ()

Removes the pmi flipping setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetPMIPrecision ()

Removes the PMI precision setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetPMISubstitutionFont ()

Removes the PMI substitution font setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetPRCReadHelper ()

Removes the PRC read helper setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetProECodePageName ()

Removes the Pro/E code page name setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetProEConstructionEntities ()

Removes the Pro/E construction entities setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetProEDatum ()

Removes the Pro/E datum setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetProEDimensionTolerance ()

Removes the Pro/E dimension tolerance setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetProEExplodedViews ()

Removes the Pro/E exploded views setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetProEFamilyTreeSource ()

Removes the Pro/E family table setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetProEHomeView ()

Removes the Pro/E home view setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetProEMissingBoolean ()

Removes the Pro/E missing boolean setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetProEMissingFlexibleComponent ()

Removes the Pro/E missing flexible setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetProESessionColor ()

Removes the Pro/E session color setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetProESkeletons ()

Removes the Pro/E skeletons setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetProESubpartPMI ()

Removes the Pro/E subpart PMI setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetRemovedViews ()

Removes the read removed views setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetRevitPhysicalProperties ()

Removes the Revit physical property setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetRhinoForceRenderedModeColors ()

Removes the Rhino force rendered mode color color setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetSearchDirectories ()

Removes the search directories setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetSearchDirectoriesByFile ()

Removes the search directories by file setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetSearchRootDirectory ()

Removes the search root directory setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetSewingTolerance ()

Removes the sewing tolerance setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetSolids ()

Removes the solid import state.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetSolidworksDisplayVisibleDatum ()

Removes the Solidworks display visible datum setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetSTEPCodePageName ()

Removes the STEP code page name setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetSTEPFirstColorPreference ()

Removes the STEP first color preference setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetSTEPNamePreference ()

Removes the STEP name preference setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetSTEPOrientationHealing ()

Removes the STEP orientation healing setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetSTEPShellBasedSurfaceModelSplitting ()

Removes the STEP shell based surface model splitting setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetSTEPValidationProperties ()

Removes the STEP validation properties setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetSurfaces ()

Removes the surface import state.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetTessellationAccuracy ()

Removes the tessellation accuracy setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetTessellationCleanup ()

Removes the tessellation cleanup setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetTessellationLevel ()

Removes the tessellation level setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetTessellationMaximumEdgeLength ()

Removes the tessellation maximum edge length setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetTessellationPreservesUVPoints ()

Removes the tessellation UV preservation setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetTextureDirectories ()

Removes the texture search directories setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetTrueColorMode ()

Removes the true color mode setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetUnigraphicsFittedCamera ()

Removes the Unigraphics fitted camera setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetUnigraphicsPreferredReferenceSets ()

Removes the Unigraphics preferred reference sets setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ImportOptionsKit UnsetWireframes ()

Removes the wireframe import state.

Return

A reference to this ImportOptionsKit.

Public Static Functions

HPS.Exchange.ImportOptionsKit GetDefault ()

Creates an ImportOptionsKit 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(const char*,const ImportOptionsKit&) or File.Translate.

Return

An ImportOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ImportOptionsKit a, HPS.Exchange.ImportOptionsKit b)

bool operator== (HPS.Exchange.ImportOptionsKit a, HPS.Exchange.ImportOptionsKit b)

class JT : public IDisposable

The Exchange.JT class is a concept class for JT-related enums.

Public Types

enum Content

Enumerates the type of content to export to a JT file.

Values:

Geometry

Export only B-rep geometry data (kA3DWriteGeomOnly).

Tessellation

Export only tessellation data (kA3DWriteTessOnly).

GeometryAndTessellation

Export BRep geometry and tessellation data (kA3DWriteGeomAndTess).

enum TessellationLevel

Enumerates the tessellation levels used when importing JT files.

Values:

Low

Load the lowest level of tessellation available in the JT file.

Medium

Load the medium level of tessellation available in the JT file.

High

Load the highest level of tessellation available in the JT file.

enum Version

Enumerates the version of the JT format to export to a JT file.

Values:

JT81

Version 8.1 of the JT format.

JT95

Version 9.5 of the JT format.

JT100

Version 10.0 of the JT format.

Public Functions

void Dispose ()

JT (HPS.Exchange.JT in_that)

class Layer : public HPS.Sprocket

The Filter class is a smart pointer. It represents an A3DAsmLayer in Exchange. The primary purpose of this class is simply to provide access to the underlying A3DAsmLayer pointer for use by Exchange library functions.

Public Functions

override void Dispose ()

HPS.Exchange.Component[] GetComponents ()

Get the list of components in this layer.

Return

A list of components in this layer.

uint GetIdentifier ()

Get the identifier of the layer.

Return

The identifier of the layer.

string GetName ()

Get the layer name.

Return

The name of the layer.

HPS.Exchange.ProductOccurrence GetProductOccurrence ()

Get the product occurrence in which the layer is defined.

Return

The product occurrence in which the layer is defined.

Layer ()

The default constructor creates an uninitialized Layer object. The Type() function will return Type.None.

Layer (HPS.Exchange.Layer in_that)

The copy constructor creates an Exchange.Layer object that shares the underlying smart-pointer of the source Exchange.Layer.

Param in_that

The source Exchange.Layer 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.

class MeasurementOperator : public HPS.Exchange.CommonMeasurementOperator

The MeasurementOperator class defines an operator which allows the user to insert measurements into the scene This operator requires the model be loaded using the Exchange bridge, and the model must contain B-rep.

The behavior of the operator, and its usage, vary based on the type of measurement the user wishes to insert.

<itemizedlist> <listitem>

Point to Point measurement: The Point to Point measurement mode allows the user to measure the distance between two arbitrary points. Usage:

</listitem> <listitem>

Click or tap where you want to insert the first measurement point.

</listitem> <listitem>

Click or tap where you want to insert the second measurement point

</listitem> <listitem>

Move the mouse or drag your finger to move the measurement geometry around.

</listitem> <listitem>

Click or lift your finger to position the measurement.

</listitem> <listitem>

Edge and Radius measurement: The Edge and Radius measurement mode allows the user to measure the length of an edge, or the radius of a circle, based on whether the edge clicked on is a line or a circle. Usage:

</listitem> <listitem>

Click or tap on the edge you want to measure

</listitem> <listitem>

Move the mouse or drag your finger to move the measurement geometry around.

</listitem> <listitem>

Click again or lift your finger to position the measurement.

</listitem> <listitem>

If the edge you selected is part of a circle, the circle radius will be measured, otherwise the edge length will be measured.

</listitem> <listitem>

Feature to Feature measurement: The Feature to Feature measurement mode allows the user to measure the shortest distance between two features. Usage:

</listitem> <listitem>

Click or tap on a face

</listitem> <listitem>

Click or tap on a different face

</listitem> <listitem>

Move the mouse or drag your finger to move the measurement geometry around.

</listitem> <listitem>

Click again or lift your finger to position the measurement.

</listitem> <listitem>

If both faces are planar, the shortest distance between them is measured

</listitem> <listitem>

If one face is planar and the other is id conical or cylindrical, the shortest distance between the center line and the face is measured

</listitem> <listitem>

If both faces are conical or cylindrical, the shortest distance between the two center lines is measured

</listitem> <listitem>

Face Angle measurement: The Face Angle measurement mode allows the user to measure the angle between two planar, non-parallel faces. Usage:

</listitem> <listitem>

Click or tap on a face

</listitem> <listitem>

Click or tap on a different face, which is not parallel to the first face

</listitem> <listitem>

Move the mouse or drag your finger to move the measurement geometry around.

</listitem> <listitem>

Click again or lift your finger to position the measurement.

</listitem> </itemizedlist>

Once a measurement has been inserted, its position can be modified by clicking on it, moving the mouse, and clicking once more once it is in the desired position. On touch-enabled devices measurements can be repositioned by dragging them into a new position. Pressing Escape will delete the measurement currently being inserted.

The operator will inject an Event of type MeasurementInsertedEvent every time a new measurement is inserted. The user can handle this event to obtain the segment key associated with every inserted measurement.

A valid CADModel needs to be passed to the constructor of this class.

Public Types

enum MeasurementType

Values:

PointToPoint

EdgeAndRadius

FeatureToFeature

FaceAngle

Public Functions

void ComputeExchangeScale (HPS.Exchange.Component in_edge_component, out double out_product_occurrence_scale, out double out_ri_scale, out double out_context_scale)

Compute the accumulated scales applied on the product occurrences, on the representation items, and on the context, until the given edge. The scales are set to 1 by default.

Param in_edge_component

The edge on which the scales are retrieved.

Param out_product_occurrence_scale

The accumulated scale on the product occurrences.

Param out_ri_scale

The scale on the representation item.

Param out_context_scale

The context scale.

void DeleteLastMeasurement ()

Delete the current measurement and brings the operator back to a state to start a new measurement

override void Dispose ()

HPS.HighlightOptionsKit GetHighlightOptions ()

Returns the highlight option kit currently used for mouse over highlighting.

Return

the highlight option kit currently used for mouse over highlighting.

HPS.Exchange.MeasurementOperator.MeasurementType GetMeasurementType ()

Returns the type of measurement the operator is currently set up to insert.

Return

The type of measurement the operator is currently set up to insert.

bool GetMouseOverHighlighting ()

Whether measurable geometry is highlighted when mousing over it

Return

true if measurable geometry is highlighted on mouse over, false otherwise.

override string GetName ()

Returns the name of the operator.

bool IsMeasurementActive ()

Whether a measurement is currently being inserted or edited.

Return

true if a measurement is being inserted or manipulated, false otherwise.

MeasurementOperator ()

MeasurementOperator (HPS.Exchange.CADModel in_cad_model)

MeasurementOperator (HPS.Exchange.CADModel in_cad_model, HPS.MouseButtons in_mouse_trigger)

MeasurementOperator (HPS.Exchange.CADModel in_cad_model, HPS.MouseButtons in_mouse_trigger, HPS.ModifierKeys in_modifier_trigger)

MeasurementOperator (HPS.Exchange.MeasurementOperator in_that)

override bool OnKeyDown (HPS.KeyboardState in_state)

This function is called whenever HPS receives a KeyDownEvent that signals a key was pressed. Pressing Escape while in the process of inserting a measurement deletes that measurement.

Return

true if the input event was handled, false otherwise.

override bool OnMouseDown (HPS.MouseState in_state)

This function is called whenever HPS receives a MouseEvent that signals a mouse button was pressed. This function inserts the measuring points.

Param in_state

A MouseState object describing the current mouse state.

Return

true if the input event was handled, false otherwise.

override bool OnMouseMove (HPS.MouseState in_state)

This function is called whenever HPS receives a MouseEvent that signals the mouse moved When the user has just inserted the second measurement point, this function allows the user to move the measurement If the user has selected an already existing measurement, this function allows the user to reposition the measurement

Param in_state

A MouseState object describing the current mouse state.

Return

true if the input event was handled, false otherwise.

override bool OnMouseUp (HPS.MouseState in_state)

This function is called whenever HPS receives a MouseEvent that signals a mouse button was released.

Param in_state

A MouseState object describing the current mouse state.

Return

true if the input event was handled, false otherwise.

override bool OnTouchDown (HPS.TouchState in_state)

This function is called whenever HPS receives a TouchEvent that signals the device was touched. This function inserts the measuring points.

Param in_state

A TouchState object describing the current touch state.

Return

true if the input event was handled, false otherwise.

override bool OnTouchMove (HPS.TouchState in_state)

This function is called whenever HPS receives a TouchEvent that signals a point of contact has moved. When the user has just inserted the second measurement point, this function allows the user to move the measurement If the user has selected an already existing measurement, this function allows the user to reposition the measurement

Param in_state

A TouchState object describing the current touch state.

Return

true if the input event was handled, false otherwise.

override bool OnTouchUp (HPS.TouchState in_state)

This function is called whenever HPS receives a TouchEvent that signals a point of contact has been released.

Param in_state

A TouchState object describing the current touch state.

Return

true if the input event was handled, false otherwise.

override void OnViewAttached (HPS.View in_attached_view)

This function is called whenever a view is attached to this operator.

Param in_attached_view

The view attached to this operator.

override void OnViewDetached (HPS.View in_detached_view)

This function is called whenever a view is detached from this operator.

Param in_detached_view

The view detached from this operator.

void SetMeasurementType (HPS.Exchange.MeasurementOperator.MeasurementType in_measurement_type)

Sets the type of measurement to insert.

Param in_measurement_type

The type of measurement to insert.

void SetMouseOverHighlighting (bool in_highlighting)

Whether measurable geometry should be highlighted when mousing over it

Param in_highlighting

Whether measurable geometry should be highlighted when mousing over it.

void SetMouseOverHighlighting (bool in_highlighting, HPS.HighlightOptionsKit in_highlight_options_kit)

Whether measurable geometry should be highlighted when mousing over it

Param in_highlighting

Whether measurable geometry should be highlighted when mousing over it.

Param in_highlight_options_kit

The highlight kit used for mouse over highlights

class ModelFileImportOptionsKit : public HPS.SprocketKit

The HPS.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 HPS.Exchange.ModelFileImportOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ModelFileImportOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.ModelFileImportOptionsKit in_kit)

Check if the source ModelFileImportOptionsKit is equivalent to this ModelFileImportOptionsKit.

Param in_kit

The source ModelFileImportOptionsKit to compare to this ModelFileImportOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

ModelFileImportOptionsKit ()

The default constructor creates an empty ModelFileImportOptionsKit object.

ModelFileImportOptionsKit (HPS.Exchange.ModelFileImportOptionsKit in_kit)

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

Param in_kit

The source ModelFileImportOptionsKit 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.Exchange.ModelFileImportOptionsKit in_kit)

Copies the source ModelFileImportOptionsKit into this ModelFileImportOptionsKit.

Param in_kit

The source ModelFileImportOptionsKit to copy.

HPS.Exchange.ModelFileImportOptionsKit SetAnnotationCaptureFitting (HPS.Exchange.AnnotationCaptureFitting in_fitting)

Sets the type of data that should be used to generate the camera for annotation captures.

Param in_fitting

The type of fitting to use for annotation captures.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit SetComputePreferredOpenShellOrientation (bool in_state)

This option lets you redirect the normal of non-solid bodies. eg: when a body is not able to be sewed closed it still has the notion of an inside and outside. the in_state will be passed to A3DSewOptionsData With this option, you are asking Exchange to use a predictive algorithm to correctly identify inside vs outside.

Param in_state

The state of the option used when importing a file

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit SetConfiguration (string in_configuration)

Sets the configuration to import from a CAD Model. This is only applicable to Catia V4, Solidworks and I-deas file formats. If no configuration is specified, the default configuration will be loaded if possible. This corresponds to the value that will be passed to A3DRWParamsMultiEntriesData::m_ppcEntries.

Param in_configuration

UTF8-encoded configuration name to import from a CAD file.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit SetConfiguration (string[] in_configuration)

Sets a nested configuration to import from a CAD Model. This is only applicable to Catia V4, Solidworks and I-deas file formats. If no configuration is specified, the default configuration will be loaded if possible. These correspond to the values that will be passed to A3DRWParamsMultiEntriesData::m_ppcEntries.

Param in_configuration

List of nested configuration names to import from a CAD file.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit SetGeometryDefaultColor (HPS.RGBAColor in_color)

Sets the color to use for non-PMI geometry in the CAD file if none is specified.

See

SetPMIDefaultColor

Param in_color

The color to use for non-PMI geometry in the CAD file if none is specified.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit SetHiddenObjects (bool in_state)

Sets whether we import the hidden objects from the CAD Model or not. The in_state will be passed to A3DRWParamsGeneralData::m_bReadHiddenObjects With this option, you are asking Exchange read the objects that are marked as hidden or graphics removed.

Param in_state

The state of the option used when importing a file

Return

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

See

Default value

Param in_state

Whether to import edges for an IFC file.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit SetLocation (HPS.ComponentPath in_path)

Sets where to insert the imported file in an existing Component hieararchy. If this option is not set, a new CADModel will be created for the imported file. If this option is specified, the underlying PRC data of the existing CADModel will be modified to include the imported file and the data will be imported into the specified location in the existing Component hierarchy and its corresponding scene graph.

Param in_path

The path describing the location to insert the imported file into. This path must either terminate at a CADModel or a Component corresponding to an A3DAsmProductOccurrence. Note that if the imported file is added along a ComponentPath with attributes specified in the PRC data, the components added to the existing PRC data will also inherit those attributes. Note also that if the path is just a CADModel, a new A3DAsmModelFile underyling the CADModel must be created to include both the existing product occurrences and the new product occurrences. This new A3DAsmModelFile will be owned by the CADModel being imported into (see CADModel.GetEntityOwnership), but the existing A3DAsmModelFile will still need to be cleaned up via A3DAsmModelFileDelete since it was not owned by the CADModel.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit SetLocation (HPS.ComponentPath in_path, HPS.MatrixKit in_transform)

Sets where to insert the imported file in an existing Component hieararchy. If this option is not set, a new CADModel will be created for the imported file. If this option is specified, the underlying PRC data of the existing CADModel will be modified to include the imported file and the data will be imported into the specified location in the existing Component hierarchy and its corresponding scene graph.

Param in_path

The path describing the location to insert the imported file into. This path must either terminate at a CADModel or a Component corresponding to an A3DAsmProductOccurrence. Note that if the imported file is added along a ComponentPath with attributes specified in the PRC data, the components added to the existing PRC data will also inherit those attributes. Note also that if the path is just a CADModel, a new A3DAsmModelFile underyling the CADModel must be created to include both the existing product occurrences and the new product occurrences. This new A3DAsmModelFile will be owned by the CADModel being imported into (see CADModel.GetEntityOwnership), but the existing A3DAsmModelFile will still need to be cleaned up via A3DAsmModelFileDelete since it was not owned by the CADModel.

Param in_transform

A transform to apply to the components being added to the existing CADModel. This transform will also be added to the underlying PRC data. Defaults to an identity transform.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit SetNURBSConversion (HPS.Exchange.NURBSConversionOptionsKit in_nurbs_conversion_options)

Converts the curves and surfaces of the model file according to the options specified.

Param in_nurbs_conversion_options

The options to use during conversion

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit SetPMIFlipping (bool in_flip)

Dictates whether Visualize will flip pmi when rotating so that text / symbols remain readable.

Note

If exchange reports that a markup does not contain leader lines, but the tessellation does contain lines that markup will not be flipped. This is a precaution for models where the leader line geometry was included as part of the markup tessellation and flipping the geometry would cause any present leader lines to point in the wrong direction.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit SetSewingTolerance (double in_tolerance)

The sewing tolerance to use on the A3DAsmModelFile prior to generating the scene graph. If this option is set, prior to generating the scene graph, the A3DAsmModelFile will be passed to A3DAsmModelFileSew with this tolerance.

Param in_tolerance

The sewing tolerance to use on the A3DAsmModelFile.

Return

A reference to this ModelFileImportOptionsKit.

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

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

See

Default value

Param in_type

The accuracy to use for tessellation generation.

Return

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

See

Default value

Param in_type

The accuracy to use for tessellation generation.

Param in_accurate_normals

Whether to compute surface normals when performing accurate tessellation. This only applies if in_type is set different than Tessellation.Accuracy.Standard. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation.

Return

A reference to this ModelFileImportOptionsKit.

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

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

See

Default value

Param in_type

The accuracy to use for tessellation generation.

Param in_accurate_normals

Whether to compute surface normals when performing accurate tessellation. This only applies if in_type is set different than Tessellation.Accuracy.Standard. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation.

Param in_accurate_surface_curvatures

Whether to take into account surfaces curvature in accurate tessellation to controle triangles elongation directions. This only applies if in_type is different than Tessellation.Accuracy.Standard. This correspond to the value that will be passed to A3DRWParamsTessellationData::m_bAccurateSurfaceCurvatures.

Return

A reference to this ModelFileImportOptionsKit.

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

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

See

Default value

Param in_type

The accuracy to use for tessellation generation.

Param in_accurate_normals

Whether to compute surface normals when performing accurate tessellation. This only applies if in_type is set different than Tessellation.Accuracy.Standard. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation.

Param in_accurate_surface_curvatures

Whether to take into account surfaces curvature in accurate tessellation to controle triangles elongation directions. This only applies if in_type is different than Tessellation.Accuracy.Standard. This correspond to the value that will be passed to A3DRWParamsTessellationData::m_bAccurateSurfaceCurvatures.

Param accurate_grid_maximum_stitch_length

Maximal grid stitch length. Disabled if value is 0. Be careful, a too small value can generate a huge tessellation. This only applies if in_type is set to Tessellation.Accuracy.GridAccurate. This correspond to the value that will be passed to A3DRWParamsTessellationData::m_bAccurateTessellationWithGrid .

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit SetTessellationCleanup (bool in_cleanup)

Dictates whether Exchange tesselation data will be released from their parent representation items during import.

Warning

Setting this option to true will cause future exports to output without tessellation data.

Param in_cleanup

Whether to clean up tessellation data from representation items.

Return

A reference to this ImportOptionsKit.

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 A3DRWParamsTessellationData::m_eTessellationLevel to kA3DTessLODUserDefined.

Param in_limit_type

The type of the chord limit to be specified.

Param in_limit

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

Param in_angle_tolerance

The 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 A3DRWParamsTessellationData::m_dAngleToleranceDeg.

Return

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

See

Default value

Param in_level

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

Return

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

See

Default value

Param in_length

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

Return

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

See

Default value

Param in_state

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

Return

A reference to this ModelFileImportOptionsKit.

void Show (out HPS.Exchange.ModelFileImportOptionsKit out_kit)

Copies this ModelFileImportOptionsKit into the given ModelFileImportOptionsKit.

Param out_kit

The ModelFileImportOptionsKit to populate with the contents of this ModelFileImportOptionsKit.

bool ShowAnnotationCaptureFitting (out HPS.Exchange.AnnotationCaptureFitting out_fitting)

Shows the annotation capture fitting setting.

Param out_fitting

The type of fitting to use for annotation captures.

Return

true if an annotation capture fitting setting was specified, false otherwise.

bool ShowComputePreferredOpenShellOrientation (out bool out_state)

Shows the compute preferred open shell orientation setting.

Param out_state

The compute preferred open shell orientation to use in the A3DSewOptionsData structure when importing a file.

Return

true if compute preferred open shell orientation setting was specified, false otherwise.

bool ShowConfiguration (out string[] out_configuration)

bool ShowGeometryDefaultColor (out HPS.RGBAColor out_color)

Shows the geometry default color setting.

Param out_color

The geometry default color setting.

Return

true if a geometry default color setting was specified, false otherwise.

bool ShowHiddenObjects (out bool out_state)

Shows the read hidden objects setting.

Param out_state

Whether to import hidden objects from the CAD model or not.

Return

true if the read hidden objects setting was specified, false otherwise.

bool ShowIFCEdges (out bool out_state)

Shows the IFC edges setting.

Param out_state

Whether to import edges for an IFC file.

Return

true if an IFC edge setting was specified, false otherwise.

bool ShowLocation (out HPS.ComponentPath out_path, out HPS.MatrixKit out_transform)

Shows the location setting.

Param out_path

The path describing the location to insert the imported file into.

Param out_transform

The transform to apply to the components being added to the existing CADModel.

Return

true if a location setting was specified, false otherwise.

bool ShowNURBSConversion (out HPS.Exchange.NURBSConversionOptionsKit out_nurbs_conversion_options)

Shows the NURBS conversion setting.

Param out_nurbs_conversion_options

The options to be used during the conversion.

Return

true if NURBS conversion setting was specified, false otherwise.

bool ShowPMIFlipping (out bool out_pmi_flipping)

Shows the pmi flipping setting.

Param out_pmi_flipping

The pmi flipping setting that was specified.

Return

true if a pmi flipping setting was specified, false otherwise.

bool ShowSewingTolerance (out double out_tolerance)

Shows the sewing tolerance setting.

Param out_tolerance

The sewing tolerance to use on the A3DAsmModelFile prior to generating the scene graph.

Return

true if a sewing tolerance setting was specified, false otherwise.

bool ShowTessellationAccuracy (out HPS.Exchange.Tessellation.Accuracy out_type, out bool out_accurate_normals, out bool out_accurate_surface_curvatures, out double out_accurate_grid_maximum_stitch_length)

Shows the tessellation accuracy setting.

Param out_type

The type of the tessellation accuracy which was specified.

Param out_accurate_normals

Whether to compute surface normals when performing accurate tessellation. This only applies if out_type is different than Tessellation.Accuracy.Standard.

Param out_accurate_surface_curvatures

Whether to take into account surfaces curvature in accurate tessellation to controle triangles elongation directions. This only applies if out_type is different than Tessellation.Accuracy.Standard.

Param out_accurate_grid_maximum_stitch_length

Maximal grid stitch length. Disabled if value is 0. Be careful, a too small value can generate a huge tessellation. This only applies if out_type is Tessellation.Accuracy.GridAccurate.

Return

true if a tessellation accuracy setting was specified, false otherwise.

bool ShowTessellationCleanup (out bool out_cleanup)

Shows the tessellation cleanup setting.

Param out_cleanup

The tesselation cleanup setting that was specified.

Return

true if a tessellation cleanup setting was specified, false otherwise.

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.

Param out_type

The type of the tessellation level setting which was specified.

Param out_level

The predefined quality of the tessellation that will be generated for BRep data. This is only valid if out_type is Tessellation.Type.Standard.

Param out_limit_type

The type of chord limit which was specified. This is only valid if out_type is Tessellation.Type.Custom.

Param out_limit

The 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 Tessellation.Type.Custom.

Param out_angle_tolerance

The maximum angle in degrees between two consecutive wire elements in the generated tessellation. This is only valid if out_type is Tessellation.Type.Custom.

Return

true if a tessellation level setting was specified, false otherwise.

bool ShowTessellationMaximumEdgeLength (out double out_length)

Shows the tessellation maximum edge length setting.

Param out_length

The tessellation maximum edge length setting.

Return

true if a tessellation maximum edge length setting was specified, false otherwise.

bool ShowTessellationPreservesUVPoints (out bool out_state)

Shows the tessellation UV preservation setting.

Param out_state

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

Return

true if a tessellation UV preservation setting was specified, false otherwise.

HPS.Exchange.ModelFileImportOptionsKit UnsetAnnotationCaptureFitting ()

Removes the annotation capture fitting setting.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit UnsetComputePreferredOpenShellOrientation ()

Removes the compute preferred open shell orientation setting.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit UnsetEverything ()

Removes all settings from this ModelFileImportOptionsKit.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit UnsetGeometryDefaultColor ()

Removes the geometry default color setting.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit UnsetHiddenObjects ()

Removes the read hidden objects setting.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit UnsetIFCEdges ()

Removes the IFC edges setting.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit UnsetLocation ()

Removes the location setting.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit UnsetNURBSConversion ()

Removes the NURBS conversion setting.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit UnsetPMIFlipping ()

Removes the pmi flipping setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit UnsetSewingTolerance ()

Removes the sewing tolerance setting.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit UnsetTessellationAccuracy ()

Removes the tessellation accuracy setting.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit UnsetTessellationCleanup ()

Removes the tessellation cleanup setting.

Return

A reference to this ImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit UnsetTessellationLevel ()

Removes the tessellation level setting.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit UnsetTessellationMaximumEdgeLength ()

Removes the tessellation maximum edge length setting.

Return

A reference to this ModelFileImportOptionsKit.

HPS.Exchange.ModelFileImportOptionsKit UnsetTessellationPreservesUVPoints ()

Removes the tessellation UV preservation setting.

Return

A reference to this ModelFileImportOptionsKit.

Public Static Functions

HPS.Exchange.ModelFileImportOptionsKit GetDefault ()

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

Return

A ModelFileImportOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ModelFileImportOptionsKit a, HPS.Exchange.ModelFileImportOptionsKit b)

bool operator== (HPS.Exchange.ModelFileImportOptionsKit a, HPS.Exchange.ModelFileImportOptionsKit b)

class NURBSConversionOptionsKit : public HPS.SprocketKit

The HPS.Exchange.NURBSConversionOptionsKit class is a user space object. It contains settings controlling how data is converted to NURBS curves and surfaces during import.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this NURBSConversionOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.NURBSConversionOptionsKit in_kit)

Check if the source NURBSConversionOptionsKit is equivalent to this NURBSConversionOptionsKit.

Param in_kit

The source NURBSConversionOptionsKit to compare to this NURBSConversionOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

NURBSConversionOptionsKit ()

The default constructor creates an empty NURBSConversionOptionsKit object.

NURBSConversionOptionsKit (HPS.Exchange.NURBSConversionOptionsKit in_kit)

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

Param in_kit

The source NURBSConversionOptionsKit 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.Exchange.NURBSConversionOptionsKit in_kit)

Copies the source NURBSConversionOptionsKit into this NURBSConversionOptionsKit.

Param in_kit

The source NURBSConversionOptionsKit to copy.

HPS.Exchange.NURBSConversionOptionsKit Set3DCurvesComputation (bool in_state)

Sets whether to compute 3D curves from BRep data. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bForceCompute3D.

Param in_state

Whether to compute 3D curves from BRep data.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit SetAllowedCurves (HPS.Exchange.CurveType[] in_allowed_curves)

Sets a list of curves types which are allowed in the resulting conversion This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_puiAcceptableCurves. The array passed to this function will be sorted.

Param in_allowed_curves

An array of curves which the conversion can produce.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit SetAllowedSurfaces (HPS.Exchange.SurfaceType[] in_allowed_surfaces)

Sets a list of surface types which are allowed in the resulting conversion This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_puiAcceptableSurfaces. The array passed to this function will be sorted.

Param in_allowed_surfaces

An array of surfaces which the conversion can produce.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit SetClosedFaceSplitting (bool in_state)

Sets whether to split closed faces. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bSplitClosedFaces.

Param in_state

Whether to split closed faces at the parametric seam and mid-parameter.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit SetCrossSeamCurveReplacement (bool in_state)

Sets whether to replace UV curves which cross seams of periodic surfaces with 3D curves. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bDeleteCrossingUV.

Param in_state

Whether to replace UV curves which cross seams of periodic surfaces.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit SetParameterization (bool in_state)

Sets whether to keep or recompute the parametrization of surfaces This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bUseSameParam.

Param in_state

If true, the parametrization information for surfaces will be retained, otherwise it will be recalculated.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit SetPeriodicFaceSplitting (bool in_state)

Sets whether to split periodic faces. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bSplitFaces.

Param in_state

Whether to split periodic faces on parametric seams.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit SetTolerance (double in_tolerance)

Sets the tolerance for the conversion. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_dTol.

Param in_tolerance

The tolerance of the resulting BRep data. The value is relative to the scale of the model.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit SetUVCurvesComputation (bool in_state, bool in_allow_cross_seam_curves)

Sets whether to compute UV curves from BRep data.

Param in_state

Whether to compute UV curves from BRep data. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bForceComputeUV.

Param in_allow_cross_seam_curves

Whether to allow UV curves to cross seams. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bAllowUVCrossingSeams.

Return

A reference to this NURBSConversionOptionsKit.

void Show (out HPS.Exchange.NURBSConversionOptionsKit out_kit)

Copies this NURBSConversionOptionsKit into the given NURBSConversionOptionsKit.

Param out_kit

The NURBSConversionOptionsKit to populate with the contents of this NURBSConversionOptionsKit.

bool Show3DCurvesComputation (out bool out_state)

Shows the 3D curve computation conversion setting.

Param out_state

Whether 3D curves will be computed by the conversion

Return

true if a 3D curve computation conversion setting was specified, false otherwise.

bool ShowAllowedCurves (out HPS.Exchange.CurveType[] out_allowed_curves)

Shows the allowed curves conversion setting.

Param out_allowed_curves

The types of curves the conversion is allowed to produce.

Return

true if an allowed curves conversion setting was specified, false otherwise.

bool ShowAllowedSurfaces (out HPS.Exchange.SurfaceType[] out_allowed_surfaces)

Shows the allowed surfaces conversion setting.

Param out_allowed_surfaces

The types of surfaces the conversion is allowed to produce.

Return

true if an allowed surfaces conversion setting was specified, false otherwise.

bool ShowClosedFaceSplitting (out bool out_state)

Shows the face splitting conversion setting.

Param out_state

Whether faces will be split by the conversion

Return

true if a closed face splitting conversion setting was specified, false otherwise.

bool ShowCrossSeamCurveReplacement (out bool out_state)

Shows the cross seam curve replacement conversion setting.

Param out_state

Whether cross seam curves are going to be replaced by the conversion

Return

true if a cross seam replacement conversion setting was specified, false otherwise.

bool ShowParameterization (out bool out_state)

Shows the parameterization conversion setting.

Param out_state

Whether existing parameterization will be maintained by the conversion

Return

true if a parameterization conversion setting was specified, false otherwise.

bool ShowPeriodicFaceSplitting (out bool out_state)

Shows the periodic face splitting conversion setting.

Param out_state

Whether periodic faces will be split by the conversion

Return

true if a periodic face splitting conversion setting was specified, false otherwise.

bool ShowTolerance (out double out_tolerance)

Shows the tolerance conversion setting.

Param out_tolerance

The tolerance that will be used for the conversion

Return

true if a tolerance conversion setting was specified, false otherwise.

bool ShowUVCurvesComputation (out bool out_state, out bool out_allow_cross_seam_curves)

Shows the UV curve computation conversion setting.

Param out_state

Whether UV curves will be computed by the conversion

Param out_allow_cross_seam_curves

Whether UV curves will be allowed to cross seams

Return

true if a UV curve computation conversion setting was specified, false otherwise.

HPS.Exchange.NURBSConversionOptionsKit Unset3DCurvesComputation ()

Removes the 3D curves computation conversion state.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetAllowedCurves ()

Removes the allowed curves conversion state.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetAllowedSurfaces ()

Removes the allowed surfaces conversion state.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetClosedFaceSplitting ()

Removes the closed face splitting conversion state.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetCrossSeamCurveReplacement ()

Removes the cross seam replacement conversion state.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetEverything ()

Removes all settings.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetParameterization ()

Removes the parameterization conversion state.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetPeriodicFaceSplitting ()

Removes the periodic face splitting conversion state.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetTolerance ()

Removes the tolerance conversion state.

Return

A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetUVCurvesComputation ()

Removes the UV curves computation conversion state.

Return

A reference to this NURBSConversionOptionsKit.

Public Static Functions

HPS.Exchange.NURBSConversionOptionsKit GetDefault ()

Creates a NURBSConversionOptionsKit 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 NURBSConversionOptionsKit with the default settings.

bool operator!= (HPS.Exchange.NURBSConversionOptionsKit a, HPS.Exchange.NURBSConversionOptionsKit b)

bool operator== (HPS.Exchange.NURBSConversionOptionsKit a, HPS.Exchange.NURBSConversionOptionsKit b)

class PRC : public IDisposable

The Exchange.PRC class is a concept class for PRC-related enums.

Public Types

enum BRepCompression

Enumerates the compression to apply to BRep data when exporting a PRC file.

Values:

None

No compression (A3DRWParamsExportPrcData::m_bCompressBrep = false).

Low

Low compression, high accurracy (kA3DCompressionLow).

Medium

Medium compression, medium accurracy (kA3DCompressionMedium).

High

High compression, low accurracy (kA3DCompressionHigh).

Public Functions

void Dispose ()

PRC (HPS.Exchange.PRC in_that)

class ProductOccurrence : public HPS.Exchange.Component

Public Functions

override void Dispose ()

bool Equals (HPS.Exchange.ProductOccurrence in_kit)

Check if the source ProductOccurrence is equivalent to this ProductOccurrence.

Param in_kit

The source ProductOccurrence to compare to this ProductOccurrence.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

HPS.Exchange.Layer[] GetLayers ()

Get the layers defined in this product occurrence.

Return

A list of all layers defined in this product occurrence.

HPS.Exchange.LoadStatus GetLoadStatus ()

Gets the load status for this product occurrence. This is primarily relevant for product occurrences coming from formats that support incremental loading. For product occurrences coming from formats that don’t support incremental loading, it can provide information about which product occurrences contain no data or could not be loaded (e.g., if there are missing files in an assembly), however, such product occurrences are still not capable of being incrementally loaded.

Return

The load status for this product occurrence.

bool IsExternalData ()

This function will check if the A3DEntity under the HPS.Exchange.Component from where we call it is an External Data Product Occurrence or not.

Return

A boolean which indicates if the product occurrence is an external data or not.

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.

ProductOccurrence ()

The default constructor creates an empty ProductOccurrence object.

ProductOccurrence (HPS.Component in_that)

This constructor creates a ProductOccurrence object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange.ProductOccurrence object. Otherwise the copy will fail and the resulting Exchange.ProductOccurrence will be invalid.

Param in_that

The source Component to copy.

ProductOccurrence (HPS.Exchange.Component in_that)

This constructor creates a ProductOccurrence object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange.ProductOccurrence object. Otherwise the copy will fail and the resulting Exchange.ProductOccurrence will be invalid.

Param in_that

The source Component to copy.

ProductOccurrence (HPS.Exchange.ProductOccurrence in_sheet)

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

Param in_sheet

The source ProductOccurrence to copy.

void Unload ()

Unloads this product occurrence. This will remove the underlying data from Exchange for this component and potentially also the corresponding component objects depending on the specified UnloadMode. This operation can only be performed for product occurrence components coming from file formats that support incremental loading (see ImportMode.Incremental). If you try to unload a product occurrence coming from a format that does not support incremental loading, an exception will be thrown.

void Unload (HPS.Exchange.UnloadMode in_mode)

Unloads this product occurrence. This will remove the underlying data from Exchange for this component and potentially also the corresponding component objects depending on the specified UnloadMode. This operation can only be performed for product occurrence components coming from file formats that support incremental loading (see ImportMode.Incremental). If you try to unload a product occurrence coming from a format that does not support incremental loading, an exception will be thrown.

Param in_mode

The unload mode to use for this product occurrence.

Public Static Functions

bool operator!= (HPS.Exchange.ProductOccurrence a, HPS.Exchange.ProductOccurrence b)

bool operator== (HPS.Exchange.ProductOccurrence a, HPS.Exchange.ProductOccurrence b)

class ProE : public IDisposable

The Exchange.ProE class is a concept class for ProE-related enums.

Public Types

enum ConstructionEntities

Enumerates how to import Construction Entities.

Values:

On

Off

AsDatum

enum FamilyTable

Enumerates how to import Family Tables.

Values:

BRepOnly

BRepOrTessellation

BRepOrTessellationOrGeneric

enum SessionColor

Enumerates what colors should be used for PMI in Wildfire files which have no color.

Values:

LastCreoVersion

ExchangeDefault

UserDefined

Public Functions

void Dispose ()

ProE (HPS.Exchange.ProE in_that)

class ReloadNotifier : public HPS.IONotifier

The ReloadNotifier class is a smart-pointer that is tied to a Component.Reload or a CADModel.Reload. It is used to interact with an ongoing reload.

Public Functions

void Assign (HPS.Exchange.ReloadNotifier in_that)

Associate this ReloadNotifier with the same component reload as the source ReloadNotifier.

Param in_that

The source ReloadNotifier for the assignment.

override void Dispose ()

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.

ReloadNotifier ()

The default constructor creates an ReloadNotifier object which is not tied to any component reload.

ReloadNotifier (HPS.Exchange.ReloadNotifier in_that)

The copy constructor creates a new ReloadNotifier object that is associated with the same component reload as the source ReloadNotifier.

Param in_that

The source ReloadNotifier to copy.

ReloadNotifier (HPS.IONotifier in_that)

The conversion constructor creates a new derived ReloadNotifier object from a base IONotifier object. The copy will only be successful if the source notifier is really an upcast of this notifier type. Otherwise the copy will fail and the resulting ReloadNotifier will be invalid.

Param in_that

The source IONotifier to copy.

class Revit : public IDisposable

The Exchange.Revit class is a concept class for Revit-related enums.

Public Types

enum PhysicalProperties

Values:

NotComputed

Computed

Public Functions

void Dispose ()

Revit (HPS.Exchange.Revit in_that)

class Sheet : public HPS.Exchange.Component

The Sheet class is a user space object. It allows users to activate drawing sheets imported via Exchange.

Public Functions

HPS.View Activate ()

Activates this sheet.

Return

the View.

override void Dispose ()

bool Equals (HPS.Exchange.Sheet in_kit)

Check if the source Sheet is equivalent to this Sheet.

Param in_kit

The source Sheet to compare to this Sheet.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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.

Sheet ()

The default constructor creates an empty Sheet object.

Sheet (HPS.Component in_that)

This constructor creates a Sheet object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange.Sheet object. Otherwise the copy will fail and the resulting Exchange.Sheet will be invalid.

Param in_that

The source Component to copy.

Sheet (HPS.Exchange.Component in_that)

This constructor creates a Sheet object that shares the underlying smart-pointer of the source Component. The copy will only be successful if the source component is really an upcast of an Exchange.Sheet object. Otherwise the copy will fail and the resulting Exchange.Sheet will be invalid.

Param in_that

The source Component to copy.

Sheet (HPS.Exchange.Sheet in_sheet)

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

Param in_sheet

The source Sheet to copy.

Public Static Functions

bool operator!= (HPS.Exchange.Sheet a, HPS.Exchange.Sheet b)

bool operator== (HPS.Exchange.Sheet a, HPS.Exchange.Sheet b)

class STEP : public IDisposable

The Exchange.STEP class is a concept class for STEP-related enums.

Public Types

enum Field

Enumerates the field from which to get the name for a product occurrence on import of a STEP file.

Values:

ProductName

Get the name from from the PRODUCT field (A3DRWParamsStepData::m_bPreferProductName = true).

NextAssemblyUsageOccurrenceID

Get the name from the first field of NEXT_ASSEMBLY_USAGE_OCCURRENCE (kA3DStepNameFromNAUO_ID).

NextAssemblyUsageOccurrenceName

Get the name from the second field of NEXT_ASSEMBLY_USAGE_OCCURRENCE (kA3DStepNameFromNAUO_NAME).

NextAssemblyUsageOccurrenceDescription

Get the name from the third field of NEXT_ASSEMBLY_USAGE_OCCURRENCE (kA3DStepNameFromNAUO_DESCRIPTION).

enum Format

Enumerates the format to use when exporting a STEP file.

Values:

AP203

The AP 203 STEP format (kA3DStepAP203).

AP214

The AP 214 STEP format (kA3DStepAP214).

AP242

The AP 242 STEP format (kA3DStepAP242).

Public Functions

void Dispose ()

STEP (HPS.Exchange.STEP in_that)

class Tessellation : public IDisposable

The Exchange.Tessellation class is a concept class for tessellation-related enums.

Public Types

enum Accuracy

Enumerates the tessellation accuracy modes for files imported or exported via HOOPS Exchange.

Values:

Standard

Accurate

GridAccurate

enum Level

Enumerates the standard tessellation levels for files imported or exported via Exchange.

Values:

ExtraLow

Pre-defined extra low tessellation level (kA3DTessLODExtraLow).

Low

Pre-defined low tessellation level (kA3DTessLODLow).

Medium

Pre-defined medium tessellation level (kA3DTessLODMedium).

High

Pre-defined high tessellation level (kA3DTessLODHigh).

ExtraHigh

Pre-defined extra high tessellation level (kA3DTessLODExtraHigh).

Public Functions

void Dispose ()

Tessellation (HPS.Exchange.Tessellation in_that)

class Chord : public IDisposable

The Exchange.Tessellation.Chord class is a concept class for chord-tessellation-related enums.

Public Types

enum Limit

Enumerates the type of chord limit that will be used to generate tessellation.

Values:

Ratio

Height

Public Functions

Chord (HPS.Exchange.Tessellation.Chord in_that)

void Dispose ()

class TessellationOptionsKit : public HPS.SprocketKit

The TessellationOptionsKit class is a user space object. It contains settings controlling how STL data is exported via Exchange.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this TessellationOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.TessellationOptionsKit in_kit)

Check if the source TessellationOptionsKit is equivalent to this TessellationOptionsKit.

Param in_kit

The source TessellationOptionsKit to compare to this TessellationOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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.Exchange.TessellationOptionsKit in_kit)

Copies the source TessellationOptionsKit into this TessellationOptionsKit.

Param in_kit

The source TessellationOptionsKit to copy.

HPS.Exchange.TessellationOptionsKit SetAccuracy (HPS.Exchange.Tessellation.Accuracy in_type)

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

Param in_type

The accuracy to use for tessellation generation.

Return

A reference to this TessellationOptionsKit.

HPS.Exchange.TessellationOptionsKit SetAccuracy (HPS.Exchange.Tessellation.Accuracy in_type, bool in_accurate_normals)

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

Param in_type

The accuracy to use for tessellation generation.

Param in_accurate_normals

Whether to compute surface normals when performing accurate tessellation. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.GridAccuracy.GridAccurate. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation.

Return

A reference to this TessellationOptionsKit.

HPS.Exchange.TessellationOptionsKit SetAccuracy (HPS.Exchange.Tessellation.Accuracy in_type, bool in_accurate_normals, bool in_accurate_surface_curvatures)

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

Param in_type

The accuracy to use for tessellation generation.

Param in_accurate_normals

Whether to compute surface normals when performing accurate tessellation. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.GridAccuracy.GridAccurate. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation.

Param in_accurate_surface_curvatures

Whether to take into account surfaces curvature in accurate tessellation to controle triangles elongation directions. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.GridAccuracy.GridAccurate. This correspond to the value that will be passed to A3DRWParamsTessellationData::m_bAccurateSurfaceCurvatures.

Return

A reference to this TessellationOptionsKit.

HPS.Exchange.TessellationOptionsKit SetAccuracy (HPS.Exchange.Tessellation.Accuracy in_type, bool in_accurate_normals, bool in_accurate_surface_curvatures, double in_accurate_grid_maximum_stitch_length)

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

Param in_type

The accuracy to use for tessellation generation.

Param in_accurate_normals

Whether to compute surface normals when performing accurate tessellation. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.GridAccuracy.GridAccurate. This correspond to the (negated) value that will be passed to A3DRWParamsTessellationData::m_bDoNotComputeNormalsInAccurateTessellation.

Param in_accurate_surface_curvatures

Whether to take into account surfaces curvature in accurate tessellation to controle triangles elongation directions. This only applies if in_type is set to Tessellation.Accuracy.Accurate or Tessellation.GridAccuracy.GridAccurate. This correspond to the value that will be passed to A3DRWParamsTessellationData::m_bAccurateSurfaceCurvatures.

Param in_accurate_grid_maximum_stitch_length

Maximal grid stitch length. Disabled if value is 0. Be careful, a too small value can generate a huge tessellation. This only applies if in_type is set to Tessellation.GridAccuracy.GridAccurate. This correspond to the value that will be passed to A3DRWParamsTessellationData::m_dAccurateTessellationWithGridMaximumStitchLength.

Return

A reference to this TessellationOptionsKit.

HPS.Exchange.TessellationOptionsKit SetLevel (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 A3DRWParamsTessellationData::m_eTessellationLevel to kA3DTessLODUserDefined.

Param in_limit_type

The type of the chord limit to be specified.

Param in_limit

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

Param in_angle_tolerance

The 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 A3DRWParamsTessellationData::m_dAngleToleranceDeg.

Return

A reference to this TessellationOptionsKit.

HPS.Exchange.TessellationOptionsKit SetLevel (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 A3DRWParamsTessellationData::m_eTessellationLevelOfDetail.

Param in_level

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

Return

A reference to this TessellationOptionsKit.

HPS.Exchange.TessellationOptionsKit SetMaximumEdgeLength (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 A3DRWParamsTessellationData::m_dMaximalTriangleEdgeLength.

Param in_length

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

Return

A reference to this TessellationOptionsKit.

HPS.Exchange.TessellationOptionsKit SetUVPointPreservation (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 A3DRWParamsTessellationData::m_bKeepUVPoints.

Param in_state

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

Return

A reference to this TessellationOptionsKit.

void Show (out HPS.Exchange.TessellationOptionsKit out_kit)

Copies this TessellationOptionsKit into the given TessellationOptionsKit.

Param out_kit

The TessellationOptionsKit to populate with the contents of this TessellationOptionsKit.

bool ShowAccuracy (out HPS.Exchange.Tessellation.Accuracy out_type, out bool out_accurate_normals, out bool out_accurate_surface_curvatures, out double out_accurate_grid_maximum_stitch_length)

Shows the accuracy setting.

Param out_type

The type of the accuracy which was specified.

Param out_accurate_normals

Whether to compute surface normals when performing accurate tessellation. This only applies if out_type is different than Tessellation.Accuracy.Standard.

Param out_accurate_surface_curvatures

Whether to take into account surfaces curvature in accurate tessellation to controle triangles elongation directions. This only applies if out_type is different than Tessellation.Accuracy.Standard.

Param out_accurate_grid_maximum_stitch_length

Maximal grid stitch length. Disabled if value is 0. Be careful, a too small value can generate a huge tessellation. This only applies if out_type is Tessellation.Accuracy.GridAccurate.

Return

true if an accuracy setting was specified, false otherwise.

bool ShowLevel (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 level setting.

Param out_type

The type of the level setting which was specified.

Param out_level

The predefined quality of the tessellation that will be generated for BRep data. This is only valid if out_type is Tessellation.Type.Standard.

Param out_limit_type

The type of chord limit which was specified. This is only valid if out_type is Tessellation.Type.Custom.

Param out_limit

The 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 Tessellation.Type.Custom.

Param out_angle_tolerance

The maximum angle in degrees between two consecutive wire elements in the generated tessellation. This is only valid if out_type is Tessellation.Type.Custom.

Return

true if a level setting was specified, false otherwise.

bool ShowMaximumEdgeLength (out double out_length)

Shows the maximum edge length setting.

Param out_length

The maximum edge length setting.

Return

true if a maximum edge length setting was specified, false otherwise.

bool ShowUVPointPreservation (out bool out_state)

Shows the UV preservation setting.

Param out_state

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

Return

true if a UV preservation setting was specified, false otherwise.

TessellationOptionsKit ()

The default constructor creates an empty TessellationOptionsKit object.

TessellationOptionsKit (HPS.Exchange.TessellationOptionsKit in_kit)

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

Param in_kit

The source TessellationOptionsKit to copy.

HPS.Exchange.TessellationOptionsKit UnsetAccuracy ()

Removes the accuracy setting.

Return

A reference to this TessellationOptionsKit.

HPS.Exchange.TessellationOptionsKit UnsetEverything ()

Removes all settings from this TessellationOptionsKit.

Return

A reference to this TessellationOptionsKit.

HPS.Exchange.TessellationOptionsKit UnsetLevel ()

Removes the level setting.

Return

A reference to this TessellationOptionsKit.

HPS.Exchange.TessellationOptionsKit UnsetMaximumEdgeLength ()

Removes the maximum edge length setting.

Return

A reference to this TessellationOptionsKit.

HPS.Exchange.TessellationOptionsKit UnsetUVPointPreservation ()

Removes the UV preservation setting.

Return

A reference to this TessellationOptionsKit.

Public Static Functions

HPS.Exchange.TessellationOptionsKit GetDefault ()

Creates an TessellationOptionsKit 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.Tessellation.

Return

An TessellationOptionsKit with the default settings.

bool operator!= (HPS.Exchange.TessellationOptionsKit a, HPS.Exchange.TessellationOptionsKit b)

bool operator== (HPS.Exchange.TessellationOptionsKit a, HPS.Exchange.TessellationOptionsKit b)

class Translation : public IDisposable

The Exchange.Translation class is a concept class for translation-related enums.

Public Types

enum AccurateEdges

Enumerates the options related to computing accurate edges used when translating files.

Values:

Off

Do not compute accurate edges.

On

Compute accurate edges.

OnlyIfNotParasolid

Only compute accurate edges if the data comes from neither Parasolid nor a format which embeds Parasolid data (NX, Solidwords, Solid Edge and JT)

enum Healing

Enumerates the healing options used when translating files.

Values:

Off

Do not perform healing.

On

Perform healing.

OnlyIfNotParasolid

Only perform healing if the data comes from neither Parasolid nor a format which embeds Parasolid data (NX, Solidwords, Solid Edge and JT)

enum Merging

Enumerates the options related to merging entities used when translating files.

Values:

Off

Do not merge entities.

On

Merge entities.

OnlyIfNotParasolid

Only merge entities if the data comes from neither Parasolid nor a format which embeds Parasolid data (NX, Solidwords, Solid Edge and JT)

enum Simplification

Enumerates the options related to simplifying geometry used when translating files.

Values:

Off

Do not simplify geometry.

On

Simplify geometry.

OnlyIfNotParasolid

Only simplify geometry if the data comes from neither Parasolid nor a format which embeds Parasolid data (NX, Solidwords, Solid Edge and JT)

Public Functions

void Dispose ()

Translation (HPS.Exchange.Translation in_that)

class TranslationNotifier : public HPS.IONotifier

The TranslationNotifier class is a smart-pointer that is tied to a file translation. It is used to interact with an ongoing translation or get the results from a completed translation.

Public Functions

void Assign (HPS.Exchange.TranslationNotifier in_that)

Associate this TranslationNotifier with the same file translation as the source TranslationNotifier.

Param in_that

The source TranslationNotifier for the assignment.

override void Dispose ()

double GetImportTime ()

Get the number of milliseconds it took Exchange to read the CAD file(s) and generate the corresponding PRC data. Throws an IOException if the translation is not complete, was not successful or was canceled.

int[] GetParasolidParts ()

Get the Parasolid parts obtained from the translation. Throws an IOException if the translation is not complete, was not successful or was canceled.

Return

The Parasolid Parts for a successful file translation.

double GetTranslationTime ()

Get the number of milliseconds it took Exchange to translate the PRC data into Parasolid data. Throws an IOException if the translation is not complete, was not successful or was canceled.

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.

TranslationNotifier ()

The default constructor creates an TranslationNotifier object which is not tied to any file translation.

TranslationNotifier (HPS.Exchange.TranslationNotifier in_that)

The copy constructor creates a new TranslationNotifier object that is associated with the same file translation as the source TranslationNotifier.

Param in_that

The source TranslationNotifier to copy.

TranslationNotifier (HPS.IONotifier in_that)

The conversion constructor creates a new derived TranslationNotifier object from a base IONotifier object. The copy will only be successful if the source notifier is really an upcast of this notifier type. Otherwise the copy will fail and the resulting TranslationNotifier will be invalid.

Param in_that

The source IONotifier to copy.

class TranslationOptionsKit : public HPS.SprocketKit

The HPS.Exchange.TranslationOptionsKit class is a user space object. It contains settings controlling what and how data is translated to Parasolid by Exchange. Calling HPS.Exchange.TranslationOptionsKit.GetDefault() will return an options kit with values found in here.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this TranslationOptionsKit has any values set on it.

Return

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

bool Equals (HPS.Exchange.TranslationOptionsKit in_kit)

Check if the source TranslationOptionsKit is equivalent to this TranslationOptionsKit.

Param in_kit

The source TranslationOptionsKit to compare to this TranslationOptionsKit.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

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.Exchange.TranslationOptionsKit in_kit)

Copies the source TranslationOptionsKit into this TranslationOptionsKit.

Param in_kit

The source TranslationOptionsKit to copy.

HPS.Exchange.TranslationOptionsKit SetAccurateEdges (HPS.Exchange.Translation.AccurateEdges in_accurate_edges)

Sets whether accurate edges will be computed as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_eComputeAccurateEdges.

Param in_accurate_edges

Whether to compute accurate edges.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetApplication (string in_name)

Sets the application name to put in the Parasolid data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_pcApplication.

Param in_name

UTF8-encoded application name to put in the Parasolid data.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetDisjointFaces (bool in_state)

Sets whether erroneous faces can be disjointed from their solids as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_bDisjoinIfFaceFaceError.

Param in_state

Whether to disjoin erroneous faces from their owning solids.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetEntityMerging (HPS.Exchange.Translation.Merging in_merging)

Sets whether entities can be merged as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_eMergeEntities.

Param in_merging

Whether to merge entities.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetExplodeMultiBodies (bool in_state)

Sets whether to explode multi-connexes B-reps into multiple bodies. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bExplodeMultiBodies.

See

Default value

Param in_state

Whether to explode multi-connexes B-reps into multiple bodies.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetHealing (HPS.Exchange.Translation.Healing in_healing)

Sets whether healing will be performed as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_eHealing.

Param in_healing

Whether to perform healing.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetHiddenObjects (bool in_state)

Sets whether to export hidden objects. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bWriteBlankedEntities.

See

Default value

Param in_state

Whether to export hidden objects.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetMultiProcessCount (uint in_count)

Sets the number of processes to use when performing translation. This should be a value between 1 and the number of cores on your system.

Note

Presently this option is only used for translations performed when using HPS.ExchangeParsolid.File.Import and HPS.ExchangeParasolid.File.Reload.

Param in_count

The number of processes to use when performing translation.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetSewing (bool in_state)

Sets whether perform sewing as part of the translation.

Param in_state

Whether to perform sewing.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetSewing (bool in_state, double in_tolerance)

Sets whether perform sewing as part of the translation.

Param in_state

Whether to perform sewing.

Param in_tolerance

The sewing tolerance in millimeters.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetSimplification (HPS.Exchange.Translation.Simplification in_simplification)

Sets whether geometry can be simplified as part of the translation. This corresponds to the value that will be passed to A3DRWParamsTranslateToPkPartsData::m_eSimplifyGeometry.

Param in_simplification

Whether to simplify geometry.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetSolidsAsFaces (bool in_state)

Sets whether to convert solids to a set of independent faces for export. This corresponds to the value that will be passed to A3DRWParamsExportIgesData::m_bSaveSolidsAsFaces.

See

Default value

Param in_state

Whether to convert solids to a set of independent faces for export.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetTessellation (bool in_state)

Sets whether to export tessellation data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_bWriteTessellation.

See

Default value

Param in_state

Whether to export tessellation data.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit SetVersion (string in_version)

Sets the version string to put in the Parasolid data. This corresponds to the value that will be passed to A3DRWParamsExportParasolidData::m_pcVersion.

Param in_version

UTF8-encoded version string to put in the Parasolid data.

Return

A reference to this TranslationOptionsKit.

void Show (out HPS.Exchange.TranslationOptionsKit out_kit)

Copies this TranslationOptionsKit into the given TranslationOptionsKit.

Param out_kit

The TranslationOptionsKit to populate with the contents of this TranslationOptionsKit.

bool ShowAccurateEdges (out HPS.Exchange.Translation.AccurateEdges out_accurate_edges)

Shows the accurate edges setting.

Param out_accurate_edges

Whether to compute accurate edges for translation.

Return

true if an accurate edges setting was specified, false otherwise.

bool ShowApplication (out string out_name)

Shows the application name setting.

Param out_name

The application name to put in the Parasolid data.

Return

true if an application name setting was specified, false otherwise.

bool ShowDisjointFaces (out bool out_state)

Shows the disjoin faces setting.

Param out_state

Whether to disjoin erroneous faces from their owning solids.

Return

true if a disjoin faces setting was specified, false otherwise.

bool ShowEntityMerging (out HPS.Exchange.Translation.Merging out_merging)

Shows the merging setting.

Param out_merging

Whether to merge entities for translation.

Return

true if a merging setting was specified, false otherwise.

bool ShowExplodeMultiBodies (out bool out_state)

Shows the explode multi bodies setting.

Param out_state

The explode multi bodies setting to put in the Parasolid data.

Return

true if a explode multi bodies setting was specified, false otherwise.

bool ShowHealing (out HPS.Exchange.Translation.Healing out_healing)

Shows the healing setting.

Param out_healing

Whether to heal data for translation.

Return

true if a healing setting was specified, false otherwise.

bool ShowHiddenObjects (out bool out_state)

Shows the hidden object translation setting.

Param out_state

Whether to translate hidden objects.

Return

true if a hidden object export setting was specified, false otherwise.

bool ShowMultiProcessCount (out uint out_count)

Shows the multi-process count setting.

Param out_count

The number of processes to use when performing translation.

Return

true if a multi-process count setting was specified, false otherwise.

bool ShowSewing (out bool out_state, out double out_tolerance)

Shows the sewing setting.

Param out_state

Whether to perform sewing for translation.

Param out_tolerance

The sewing tolerance. Only valid if out_state is true.

Return

true if a sewing setting was specified, false otherwise.

bool ShowSimplification (out HPS.Exchange.Translation.Simplification out_simplification)

Shows the simplification setting.

Param out_simplification

Whether to simplify geometry for translation.

Return

true if a simplification setting was specified, false otherwise.

bool ShowSolidsAsFaces (out bool out_state)

Shows the solids to faces conversion setting.

Param out_state

Whether to convert solids to a set of independent faces for translation.

Return

true if a solids to faces conversion setting was specified, false otherwise.

bool ShowTessellation (out bool out_state)

Shows the tessellation translation setting.

Param out_state

Whether to export tessellation data.

Return

true if a tessellation export setting was specified, false otherwise.

bool ShowVersion (out string out_version)

Shows the version string setting.

Param out_version

The version string to put in the Parasolid data.

Return

true if a version string setting was specified, false otherwise.

TranslationOptionsKit ()

The default constructor creates an empty TranslationOptionsKit object.

TranslationOptionsKit (HPS.Exchange.TranslationOptionsKit in_kit)

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

Param in_kit

The source TranslationOptionsKit to copy.

HPS.Exchange.TranslationOptionsKit UnsetAccurateEdges ()

Removes the accurate edges setting.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetApplication ()

Removes the application name setting.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetDisjointFaces ()

Removes the disjoin faces setting.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetEntityMerging ()

Removes the merging setting.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetEverything ()

Removes all settings from this TranslationOptionsKit.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetExplodeMultiBodies ()

Removes the explode multi bodies setting.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetHealing ()

Removes the healing setting.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetHiddenObjects ()

Removes the hidden objects export setting.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetMultiProcessCount ()

Removes the multi-process count setting.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetSewing ()

Removes the sewing setting.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetSimplification ()

Removes the simplification setting.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetSolidsAsFaces ()

Removes the solids to faces conversion setting.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetTessellation ()

Removes the tessellation export setting.

Return

A reference to this TranslationOptionsKit.

HPS.Exchange.TranslationOptionsKit UnsetVersion ()

Removes the version string setting.

Return

A reference to this TranslationOptionsKit.

Public Static Functions

HPS.Exchange.TranslationOptionsKit GetDefault ()

Creates a TranslationOptionsKit 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 translation unless an option is overridden by the options passed to one of the Translate functions.

Return

A TranslationOptionsKit with the default settings.

bool operator!= (HPS.Exchange.TranslationOptionsKit a, HPS.Exchange.TranslationOptionsKit b)

bool operator== (HPS.Exchange.TranslationOptionsKit a, HPS.Exchange.TranslationOptionsKit b)

class U3D : public IDisposable

The Exchange.U3D class is a concept class for U3D-related enums.

Public Types

enum Version

Enumerates the version to use when exporting a U3D file.

Values:

ECMA1

ECMA-363, version 1 (kA3DECMA1).

ECMA3

ECMA-363, version 3 (kA3DECMA3).

Public Functions

void Dispose ()

U3D (HPS.Exchange.U3D in_that)