Overview

Sample Code

Programming Guide

API Reference

Support

HPS.Exchange Class Reference

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

Classes

class  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. More...
 
class  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. More...
 
class  CommonMeasurementOperator
 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. More...
 
class  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. More...
 
class  Configuration
 The Configuration class is a user space object. It is a used to get configuration information for a CAD file. More...
 
class  ExportACISOptionsKit
 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. More...
 
class  ExportIGESOptionsKit
 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. More...
 
class  ExportJTOptionsKit
 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. More...
 
class  ExportNotifier
 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. More...
 
class  ExportParasolidOptionsKit
 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. More...
 
class  ExportPRCOptionsKit
 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. More...
 
class  ExportSTEPOptionsKit
 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. More...
 
class  ExportSTLOptionsKit
 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. More...
 
class  ExportU3DOptionsKit
 The HPS::Exchange::ExportU3DOptionsKit class is a user space object. It contains settings controlling how U3D data is exported via Exchange. Calling HPS::Exchange::ExportU3DOptionsKit::GetDefault() will return an options kit with values found in here. More...
 
class  ExportXMLOptionsKit
 The HPS::Exchange::ExportXMLOptionsKit class is a user space object. It contains settings controlling how XML data is exported via Exchange. Calling HPS::Exchange::ExportXMLOptionsKit::GetDefault() will return an options kit with values found in here. More...
 
class  Factory
 The Factory class is used to create and Exchange objects which inherit from HPS::Component or one of its subclasses. More...
 
class  File
 The File class provides functions to import and export CAD files via Exchange. More...
 
class  Filter
 The Filter class is a smart pointer. It represents an A3DAsmFilter in Exchange. The primary purpose of this class is simply to provide access to the underlying A3DAsmFilter pointer for use by Exchange library functions. More...
 
class  ImportNotifier
 The ImportNotifier class is a smart-pointer that is tied to a file import. It is used to interact with an ongoing import or get the results from a completed import. More...
 
class  ImportOptionsKit
 The HPS::Exchange::ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via Exchange. Calling HPS::Exchange::ImportOptionsKit::GetDefault() will return an options kit with values found in here. More...
 
class  JT
 The Exchange::JT class is a concept class for JT-related enums. More...
 
class  MeasurementOperator
 The MeasurementOperator class defines an operator which allows the user to insert measurements into the scene This operator requires the model be loaded using the Exchange bridge, and the model must contain B-rep.The behavior of the operator, and its usage, vary based on the type of measurement the user wishes to insert.Point to Point measurement: The Point to Point measurement mode allows the user to measure the distance between two arbitrary points. Usage:Click where you want to insert the first measurement point.Click where you want to insert the second measurement pointMove the mouse to move the measurement geometry around.Click to position the measurement.Edge and Radius measurement: The Edge and Radius measurement mode allows the user to measure the length of an edge, or the radius of a circle, based on whether the edge clicked on is a line or a circle. Usage:Click on the edge you want to measureMove the mouse to move the measurement geometry around.Click again to position the measurement.If the edge you clicked on is part of a cir cle, the circle radius will be measured, otherwise the edge length will be measured.Feature to Feature measurement: The Feature to Feature measurement mode allows the user to measure the shortest distance between two features. Usage:Click on a faceClick on a different faceMove the mouse to move the measurement geometry around.Click again to position the measurement.If both faces are planar, the shortest distance between them is measuredIf one face is planar and the other is id conical or cylindrical, the shortest distance between the center line and the face is measuredIf both faces are conical or cylindrical, the shortest distance between the two center lines is measuredFace Angle measurement: The Face Angle measurement mode allows the user to measure the angle between two planar, non-parallel faces. Usage:Click on a faceClick on a different face, which is not parallel to the first faceMove the mouse to move the measurement geometry around.Click again to position the measurement.Once a measurement has been inserted, its position can be modified by clicking on it, moving the mouse, and clicking once more once it is in the desired position. Pressing Escape will delete the measurement currently being inserted.The operator will inject an Event of type MeasurementInsertedEvent every time a new measurement is inserted. The user can handle this event to obtain the segment key associated with every inserted measurement.A valid CADModel needs to be passed to the constructor of this class. More...
 
class  ModelFileImportOptionsKit
 The HPS::Exchange::ModelFileImportOptionsKit class is a user space object. It contains settings (potentially) controlling how data is imported via Exchange. This particular options kit is used when importing an A3DAsmModelFile directly (see Exchange::File::Import(void*,const ModelFileImportOptionsKit&)) and as such the options will only be used if the A3DAsmModelFile permits (e.g., tessellation options will only be used if tessellation needs to be generated and the A3DAsmModelFile has BRep data). Calling HPS::Exchange::ModelFileImportOptionsKit::GetDefault() will return an options kit with values found in here. More...
 
class  PRC
 The Exchange::PRC class is a concept class for PRC-related enums. More...
 
class  ProductOccurrence
 
class  ProE
 The Exchange::ProE class is a concept class for ProE-related enums. More...
 
class  ReloadNotifier
 The ReloadNotifier class is a smart-pointer that is tied to a Component::Reload or a CADModel::Reload. It is used to interact with an ongoing reload. More...
 
class  Sheet
 The Sheet class is a user space object. It allows users to activate drawing sheets imported via Exchange. More...
 
class  STEP
 The Exchange::STEP class is a concept class for STEP-related enums. More...
 
class  Tessellation
 The Exchange::Tessellation class is a concept class for tessellation-related enums. More...
 
class  TessellationOptionsKit
 The TessellationOptionsKit class is a user space object. It contains settings controlling how STL data is exported via Exchange. More...
 
class  Translation
 The Exchange::Translation class is a concept class for translation-related enums. More...
 
class  TranslationNotifier
 The TranslationNotifier class is a smart-pointer that is tied to a file translation. It is used to interact with an ongoing translation or get the results from a completed translation. More...
 
class  TranslationOptionsKit
 The HPS::Exchange::TranslationOptionsKit class is a user space object. It contains settings controlling what and how data is translated to Parasolid by Exchange. Calling HPS::Exchange::TranslationOptionsKit::GetDefault() will return an options kit with values found in here. More...
 
class  U3D
 The Exchange::U3D class is a concept class for U3D-related enums. More...
 

Public Types

enum  AnnotationCaptureFitting { AnnotationCaptureFitting.PMIOnly = 0, AnnotationCaptureFitting.ModelAndPMI = 1 }
 Enumerates the type of data in the scene to use to generate cameras for annotation captures. More...
 
enum  BRepMode { TessellationOnly = 0, BRepOnly = 1, BRepAndTessellation = 2 }
 Enumerates the ways in which to import BRep and tessellation data for files imported via Exchange. More...
 
enum  ImportMode { Complete = 0, Incremental = 1 }
 Enumerates the ways in which to perform file import via Exchange. More...
 
enum  LoadStatus {
  Unknown = 0, Loaded = 1, VisualizationOnly = 2, PartiallyLoaded = 3,
  NotLoaded = 4
}
 Enumerates the various load statuses for a ProductOccurrence. More...
 
enum  Units {
  Units.Unknown = 0, Units.Point = 1, Units.Inch = 2, Units.Millimeter = 3,
  Units.Centimeter = 4, Units.Pica = 5, Units.Foot = 6, Units.Yard = 7,
  Units.Meter = 8, Units.Kilometer = 9, Units.Mile = 10
}
 Enumerates the units for files imported via Exchange. More...
 
enum  UnloadMode { ExchangeAndVisualization = 0, ExchangeOnly = 1 }
 Enumerates the ways in which a ProductOccurrence can be unloaded. More...
 

Detailed Description

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

Member Enumeration Documentation

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

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

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

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

Enumerates the various load statuses for a ProductOccurrence.

Enumerates the units for files imported via Exchange.

Enumerator
Unknown 

Unknown unit type (kA3DUnitUnknown).

Point 

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

Inch 

Inch units (kA3DUnitInch).

Millimeter 

Millimeter units (kA3DUnitMillimeter).

Centimeter 

Centimeter units (kA3DUnitCentimeter).

Pica 

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

Foot 

Foot units (kA3DUnitFoot).

Yard 

Yard units (kA3DUnitYard).

Meter 

Meter units (kA3DUnitMeter).

Kilometer 

Kilometer units (kA3DUnitKilometer).

Mile 

Mile units (kA3DUnitMile).

Enumerates the ways in which a ProductOccurrence can be unloaded.


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