AIFXGFileFormat.h File Reference

#include "AIDictionary.h"
#include "AIPlugin.h"
#include "AITypes.h"
#include "IAIFilePath.hpp"
#include "AIArray.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIFXGWriteStreamInterface
	Streaming interface to be supplied by the client, to be used when calling AIFXGFileFormatSuite::ExportFXGToStream(). More...
struct	AIFXGFileFormatSuite
	Stream interface to be passed to AIFXGFileFormatSuite::ExportFXGToStream(). More...
Defines
#define	kAIFXGFileFormatSuite   "AI FXG File Format Suite"
#define	kAIFXGFileFormatSuiteVersion   AIAPI_VERSION(4)
#define	kAIFXGFileFormatVersion   kAIFXGFileFormatSuiteVersion
#define	kFXGWarningNotFoundErr   '!FND'
	Error codes.
Typedefs
typedef AIArrayRef	AIFXGSaveWarnings
	Type to hold FXG Save warnings.
typedef AIDictionaryRef	AIFXGFileFormatSaveParams
	Type to hold FXG Save options.
Enumerations
enum	AIFXGVersion { kAIFXGVersion1pt0 = 1, kAIFXGVersion2pt0 = 2, kAIFXGDefaultVersion = kAIFXGVersion2pt0 }
	FXG Version constants. More...
enum	AIFXGPreservePolicy {   kAIFXGPreserveAppearanceExpand = 1, kAIFXGPreserveAppearanceRasterize, kAIFXGPreserveEditibility, kAIFXGPreserveAuto,   kAIFXGDefaultTextPreservePolicy = kAIFXGPreserveAuto, kAIFXGDefaultFiltersPreservePolicy = kAIFXGPreserveEditibility, kAIFXGDefaultGradientsPreservePolicy = kAIFXGPreserveAuto }
	Preserve policies to be used for object which may result in visual differences. More...
enum	AIFXGRasterizeResolution {   kAIFXGResolutionScreen = 72, kAIFXGResolutionMedium = 150, kAIFXGResolutionHigh = 300, kAIFXGResolutionCustom = -1,   kAIFXGDefaultRasterizeResoultion = kAIFXGResolutionScreen }
	Rasterize resolution to be used when an object will be rasterized if its appearance can not be preserved otherwise. More...
enum	AIFXGAssetTypeEnum {   kAIFXGAssetTypeMasterFile = 0, kAIFXGAssetTypeArtboardFile = 1, kAIFXGAssetTypeImage = 2, kAIFXGAssetXMP = 3,   kAIFXGAssetTypeMax = 0xFFFF }
	Asset types that can be generated on save. More...
enum	AIFXGExpandArtOptionEnum {   kAIFXGExpandArtOptionNone = 0, kAIFXGExpandArtOptionRasterize = 1, kAIFXGExpandArtOptionExpand = 2, kAIFXGExpandArtOptionStructure = 3,   kAIFXGExpandArtOptionPlaceholder = 4, kAIFXGExpandArtOptionAuto = 5, kAIFXGDefaultExpandArtOptionBlends = kAIFXGExpandArtOptionAuto, kAIFXGExpandArtOptionMax = 0xFFFF }
	Expand option to be used for a particular art object. More...
enum	AIFXGExportFlagEnum {   kAIFXGExportFlagMasterFile = 1, kAIFXGExportFlagArtboards = 1 << 1, kAIFXGExportFlagBoth = kAIFXGExportFlagMasterFile | kAIFXGExportFlagArtboards, kAIFXGExportFlagDefault = kAIFXGExportFlagMasterFile,   kAIFXGExportFlagMax = 0xFFFF }
	Export flag to be used while exporting file to FXG. More...

---

Detailed Description

---

Define Documentation

#define kAIFXGFileFormatSuite   "AI FXG File Format Suite"

#define kAIFXGFileFormatSuiteVersion   AIAPI_VERSION(4)

#define kAIFXGFileFormatVersion   kAIFXGFileFormatSuiteVersion

---

Typedef Documentation

typedef AIDictionaryRef AIFXGFileFormatSaveParams

Type to hold FXG Save options.

See AIFXGFileFormatSuite

typedef AIArrayRef AIFXGSaveWarnings

Type to hold FXG Save warnings.

See AIFXGFileFormatSuite

---

Enumeration Type Documentation

enum AIFXGAssetTypeEnum

Asset types that can be generated on save.

See AIFXGFileFormatSuite

Enumerator:

kAIFXGAssetTypeMasterFile	Main File.
kAIFXGAssetTypeArtboardFile	Artboard specific file.
kAIFXGAssetTypeImage	Image file, either JPG, PNG or GIF.
kAIFXGAssetXMP	XMP file.
kAIFXGAssetTypeMax	Maximum allowed value.

enum AIFXGExpandArtOptionEnum

Expand option to be used for a particular art object.

See AIFXGWriteStreamInterface::GetExpandOptionForArt()

Enumerator:

kAIFXGExpandArtOptionNone	Art will not be modified.
kAIFXGExpandArtOptionRasterize	Art will be rasterized.
kAIFXGExpandArtOptionExpand	Art will be expanded using AIExpandSuite::Expand().
kAIFXGExpandArtOptionStructure	Art will be played without preserving appearance, will try to map editability in consuming app.
kAIFXGExpandArtOptionPlaceholder	Art will only have a placeholder group tag, this placeholder group will be replaced by another object on round-trip.
kAIFXGExpandArtOptionAuto	Art will either be expanded, or rasterized based on the complexity of the art.
kAIFXGDefaultExpandArtOptionBlends	Default Expand option for Blends.
kAIFXGExpandArtOptionMax	Maximum allowed value.

enum AIFXGExportFlagEnum

Export flag to be used while exporting file to FXG.

Enumerator:

kAIFXGExportFlagMasterFile	Export the main file.
kAIFXGExportFlagArtboards	Export the Artboard- specific files.
kAIFXGExportFlagBoth	Export Main file as well as Artboard-specific files.
kAIFXGExportFlagDefault	Default value of this flag that can be used if you are not sure.
kAIFXGExportFlagMax	Maximum allowed value.

enum AIFXGPreservePolicy

Preserve policies to be used for object which may result in visual differences.

See AIFXGFileFormatSuite

Enumerator:

kAIFXGPreserveAppearanceExpand	Preserves the appearance of AI art object by expanding it.
kAIFXGPreserveAppearanceRasterize	Preserves the appearance of AI art object by rasterizing it.
kAIFXGPreserveEditibility	Preserves the editibility of AI Art object by mapping directly to corresponding FXG tag. It may result in loss of appearance in target application.
kAIFXGPreserveAuto	Perserves editability whenever possible without altering the appearance. If appearance cannot be matched, expands or rasterizes art.
kAIFXGDefaultTextPreservePolicy	Default preserve policy for Text.
kAIFXGDefaultFiltersPreservePolicy	Default preserve policy for FXG Filters.
kAIFXGDefaultGradientsPreservePolicy	Default preserve policy for Gradients.

enum AIFXGRasterizeResolution

Rasterize resolution to be used when an object will be rasterized if its appearance can not be preserved otherwise.

See AIFXGFileFormatSuite

Enumerator:

kAIFXGResolutionScreen	Resolution at 72 ppi.
kAIFXGResolutionMedium	Resolution at 150 ppi.
kAIFXGResolutionHigh	Resolution at 300 ppi.
kAIFXGResolutionCustom	Custom resolution, specified by another parameter of AIFXGFileFormatSuite::SetFXGSaveRasterizeResolution().
kAIFXGDefaultRasterizeResoultion	Default resolution.

enum AIFXGVersion

FXG Version constants.

Enumerator:

kAIFXGVersion1pt0	FXG version 1.0.
kAIFXGVersion2pt0	FXG version 2.0.
kAIFXGDefaultVersion	Default FXG Version.