GeometryExporter

The geometry exporter. Geometry can be exported to a variety of formats.

Example

application = cf.Application.getInstance()
project = application:NewProject()

    -- Add geometry to export and then export it to an ACIS file

cuboid = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1)

project.Exporter.Geometry.ExportFileFormat = cf.Enums.ExportGeometryFileFormatEnum.ACIS
project.Exporter.Geometry:Export([[temp_Export.sat]])

Inheritance

The GeometryExporter object is derived from the Object object.

Usage locations

The GeometryExporter object can be accessed from the following locations:

Property List

ACISVersion
Controls which file version to export to when exporting ACIS files. Only valid if ExportFileFormat is ACIS. (Read/Write ExportACISVersionEnum)
CATIAV5Version
Controls which file version to export to when exporting CATIAV5 files. Only valid if ExportFileFormat is CATIAV5. (Read/Write ExportCATIAV5VersionEnum)
ExportFileFormat
The export file format. (Read/Write ExportGeometryFileFormatEnum)
Label
The object label. (Read/Write string)
ParasolidFileFormat
The Parasolid topology type. Only valid if ExportFileFormat is Parasolid. (Read/Write ParasolidExportFileFormatEnum)
ParasolidTopologyType
The Parasolid topology type. Only valid if ExportFileFormat is Parasolid. (Read/Write ParasolidTopologyTypeEnum)
ParasolidVersion
Controls which file version to export to when exporting Parasolid files. Only valid if ExportFileFormat is Parasolid. (Read/Write ExportParasolidVersionEnum)
Type
The object type string. (Read only string)

Method List

Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity. (Returns a Object object.)
Export (filename string)
Export all geometry.
ExportParts (filename string, geometrylist List of Geometry)
Export only the specified geometry.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetProperties (properties Object)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

ACISVersion
Controls which file version to export to when exporting ACIS files. Only valid if ExportFileFormat is ACIS.
Type
ExportACISVersionEnum
Access
Read/Write
CATIAV5Version
Controls which file version to export to when exporting CATIAV5 files. Only valid if ExportFileFormat is CATIAV5.
Type
ExportCATIAV5VersionEnum
Access
Read/Write
ExportFileFormat
The export file format.
Type
ExportGeometryFileFormatEnum
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
ParasolidFileFormat
The Parasolid topology type. Only valid if ExportFileFormat is Parasolid.
Type
ParasolidExportFileFormatEnum
Access
Read/Write
ParasolidTopologyType
The Parasolid topology type. Only valid if ExportFileFormat is Parasolid.
Type
ParasolidTopologyTypeEnum
Access
Read/Write
ParasolidVersion
Controls which file version to export to when exporting Parasolid files. Only valid if ExportFileFormat is Parasolid.
Type
ExportParasolidVersionEnum
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity.
Return
Object
The new (duplicated) entity.
Export (filename string)
Export all geometry.
Input Parameters
filename(string)
The name of the file to be exported.
ExportParts (filename string, geometrylist List of Geometry)
Export only the specified geometry.
Input Parameters
filename(string)
The name of the file to be exported.
geometrylist(List of Geometry)
The list of geometry that must be exported.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
Return
table
A table defining the properties.
SetProperties (properties Object)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Input Parameters
properties(Object)
A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.