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 (<a target=”_blank”.

Equation

Curve described by an equation (kA3DTypeCrvEquation ).

Helix

Helix (<a target=”_blank”.

Hyperbola

Hyperbola (kA3DTypeCrvHyperbola ).

Intersection

Intersection between two surfaces (kA3DTypeCrvIntersection ).

Line

Line (<a target=”_blank”.

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 (<a target=”_blank”.

Cone

Conical surface (kA3DTypeSurfCone ).

Cylinder

Cylindrical surface (kA3DTypeSurfCylinder ).

Offset

Offset surface (<a target=”_blank”.

Pipe

Pipe surface (kA3DTypeSurfPipe ).

Plane

Planar surface (kA3DTypeSurfPlane ).

Ruled

Ruled surface (kA3DTypeSurfRuled ).

Sphere

Spherical surface (kA3DTypeSurfSphere ).

Revolution

Revolution surface (kA3DTypeSurfRevolution ).

Extrusion

An Extrusion (<a target=”_blank”.

FromCurve

Surface defined from a curve (kA3DTypeSurfFromCurves).

Torus

Torus surface (<a target=”_blank”.

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 (<a target=”_blank”.

Inch

Inch units (kA3DUnitInch).

Millimeter

Millimeter units (kA3DUnitMillimeter).

Centimeter

Centimeter units (kA3DUnitCentimeter).

Pica

Pica (1/72 of a foot) units (<a target=”_blank”.

Foot

Foot units (kA3DUnitFoot).

Yard

Yard units (kA3DUnitYard).

Meter

Meter units (kA3DUnitMeter).

Kilometer

Kilometer units (kA3DUnitKilometer).

Mile

Mile units (<a target=”_blank”.

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.

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.

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