Class GraphicConverter

Abstract base class for 3D graphics and CAD converters

Inheritance

Object

GraphicConverter

Namespace: ABB.Robotics.RobotStudio.Stations

Assembly: ABB.Robotics.RobotStudio.Stations.dll

Syntax

public abstract class GraphicConverter

Constructors

GraphicConverter()

Declaration

protected GraphicConverter()

Properties

DisplayName

Display Name of the file format (e.g. "VRML", "Catia V5")

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
String

Extensions

Returns a collection of supported file extensions. Each extensions should be on the form ".xxx"

Declaration

public Collection<string> Extensions { get; }

Property Value

Type	Description
Collection<String>

FileFormatFilter

Gets a filter string for use in a file dialog when importing geometry.

Declaration

public virtual string FileFormatFilter { get; }

Property Value

Type	Description
String

Hidden

Indicates that the converter should not be visible in GUI but available for API use.

Declaration

public bool Hidden { get; set; }

Property Value

Type	Description
Boolean

LicenseFeature

Gets or sets a license feature that is required to operate the converter.

Declaration

public string LicenseFeature { get; set; }

Property Value

Type	Description
String

SupportsExport

Gets or sets if the converter supports export.

Declaration

public bool SupportsExport { get; set; }

Property Value

Type	Description
Boolean

SupportsImport

Gets or sets if the converter supports import.

Declaration

public bool SupportsImport { get; set; }

Property Value

Type	Description
Boolean

Methods

BuildFilter(IEnumerable<String>)

Declaration

protected string BuildFilter(IEnumerable<string> extensions)

Parameters

Type	Name	Description
IEnumerable<String>	extensions

Returns

Type	Description
String

CanExport(ProjectObject)

Gets if the converter can export the specified object.

Declaration

public virtual bool CanExport(ProjectObject projectObject)

Parameters

Type	Name	Description
ProjectObject	projectObject

Returns

Type	Description
Boolean

CanImportAsPart(String)

Returns true if the converter can convert an assembly to a single Part when importing (if the AsPart flag is true).

Declaration

public virtual bool CanImportAsPart(string fileName)

Parameters

Type	Name	Description
String	fileName

Returns

Type	Description
Boolean

Export(ProjectObject, String, GraphicExportSettings)

Override this to provide an Export implementation

Declaration

public virtual void Export(ProjectObject projectObject, string fileName, GraphicExportSettings settings)

Parameters

Type	Name	Description
ProjectObject	projectObject
String	fileName
GraphicExportSettings	settings

Remarks

The CanExport property must be set to true for this method to be called.

GetExportExtensions(ProjectObject)

Gets the file extensions valid for export of the specified object.

Declaration

public virtual IEnumerable<string> GetExportExtensions(ProjectObject projectObject)

Parameters

Type	Name	Description
ProjectObject	projectObject

Returns

Type	Description
IEnumerable<String>

GetExportFilter(ProjectObject)

Gets a filter string for use in a file dialog for exporting the specified object.

Declaration

public virtual string GetExportFilter(ProjectObject projectObject)

Parameters

Type	Name	Description
ProjectObject	projectObject

Returns

Type	Description
String

ImportAsync(String, GraphicImportSettings, IProgressCallback)

Override this to provide an Import implementation

Declaration

public virtual Task<GraphicComponent> ImportAsync(string fileName, GraphicImportSettings settings, IProgressCallback progress)

Parameters

Type	Name	Description
String	fileName
GraphicImportSettings	settings
IProgressCallback	progress

Returns

Type	Description
Task<GraphicComponent>

Remarks

The CanImport property must be set to true for this method to be called.

SetCancellationToken(CancellationToken)

Declaration

public virtual void SetCancellationToken(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

SupportsCancel()

Gets if the converter supports cancellation of an export operation.

Declaration

public virtual bool SupportsCancel()

Returns

Type	Description
Boolean