Simplygon 10.3.2100.0
class ImageDataExporter
Class for saving image data to different file formats.
Properties
| Property | Description |
|---|---|
| DDSCompressionType | The DDS block compression type to use. The block compression type will alter the number of output channels. BC1-3 - 3 channels. BC4 - 1 channel. BC5 - 3 channels. |
| ExportFilePath | The main export file path. This must always be set. |
| ImageFileFormat | Output image file format to use. |
| Name | The name of the ImageDataExporter object. (Inherited from Object) |
Methods
| Method | Description |
|---|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| Clear | Close any open file or stream, release any allocated data. |
| GetClass | Get the name of the ImageDataExporter class. (Inherited from Object) |
| IsA | Returns true if ImageDataExporter is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the ImageDataExporter object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the ImageDataExporter object is valid. (Inherited from Object) |
| NonNull | Returns true if the ImageDataExporter object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the ImageDataExporter object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| RunExport | Runs the export. Note that all parameters must be setup before exporting. |
| SetImage | The image data to export. |
Static methods
| Method | Description |
|---|---|
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| SafeCast | SafeCast makes sure the input object is of a class that can be cast into spImageDataExporter, and if this is the case, returns the object cast into spImageDataExporter. (Inherited from Object) |
Properties details
DDSCompressionType
The DDS block compression type to use. The block compression type will alter the number of output channels. BC1-3 - 3 channels. BC4 - 1 channel. BC5 - 3 channels.
ExportFilePath
The main export file path. This must always be set.
ImageFileFormat
Output image file format to use.
Name
The name of the ImageDataExporter object. (Inherited from Object)
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Clear
Close any open file or stream, release any allocated data.
GetClass
Get the name of the ImageDataExporter class. (Inherited from Object)
IsA
Returns true if ImageDataExporter is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull
Returns true if the ImageDataExporter object is invalid. (Inherited from Object)
IsSameObjectAs
Returns true if the ImageDataExporter object is valid. (Inherited from Object)
NonNull
Returns true if the ImageDataExporter object is valid. (Inherited from Object)
PrintInfo
Prints the content/info of the ImageDataExporter object to the log. (Inherited from Object)
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
RunExport
Runs the export. Note that all parameters must be setup before exporting.
SetImage
The image data to export.
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCast
SafeCast makes sure the input object is of a class that can be cast into spImageDataExporter, and if this is the case, returns the object cast into spImageDataExporter. (Inherited from Object)