AISVGFilterSuite Struct Reference
[API Suite List]

The SVG-filter Effect makes it possible to apply SVG filters to Illustrator artwork, from a global list associated with the current document. More...

#include <AISVGFilter.h>

List of all members.

Public Attributes
AIAPI AIErr(*	NewSVGFilter )(AISVGFilterHandle *newFilter)
	Creates a new SVG filter in the current document.
AIAPI AIErr(*	DeleteSVGFilter )(AISVGFilterHandle filter)
	Deletes an SVG filter from the current document.
AIAPI AIErr(*	CountSVGFilters )(ai::int32 *count)
	Gets the number of SVG filters in the current document.
AIAPI AIErr(*	GetNthSVGFilter )(ai::int32 n, AISVGFilterHandle *filter)
	Retrieves an SVG filter from the filter list for the current document.
AIAPI AIErr(*	SetSVGFilterContents )(AISVGFilterHandle filter, AIXMLNodeRef filterContents, AIBool8 forceUniqueID)
	Sets the contents of an SVG filter.
AIAPI AIErr(*	GetSVGFilterContents )(AISVGFilterHandle filter, AIXMLNodeRef *filterContents)
	Retrieves the contents of an SVG filter.
AIAPI AIErr(*	GetSVGFilter )(const ai::UnicodeString &name, AISVGFilterHandle *filter)
	Retrieves the filter handle associated with an identifying name string.
AIAPI AIErr(*	GetSVGFilterUIDName )(AISVGFilterHandle filter, ai::UnicodeString &name)
	Retrieves the identifying name string for a filter handle,.
AIAPI AIErr(*	GetSVGFilterArt )(AIArtHandle art, AIArtHandle *svgArt)
	Retrieves a copy of art that is used for an SVG Filter Effect on the specified art object.
AIAPI AIErr(*	DisposeFilterArt )(AIArtHandle art)
	Disposes of the input/output art for an SVG filter, as returned by GetSVGFilterArt().
AIAPI AIErr(*	AttachFilter )(AIArtHandle art, AISVGFilterHandle filter)
	Applies an SVG filter to artwork.
AIAPI AIErr(*	SVGFilterFromAIArtStyle )(const AIArtStyleHandle artStyle, AISVGFilterHandle *filter)
	Generates an SVG filter to represent an art style, if possible.

---

Detailed Description

The SVG-filter Effect makes it possible to apply SVG filters to Illustrator artwork, from a global list associated with the current document.

Filters are preserved, if possible, when the SVG file is written.

This suite provides functions that allow you to manage the global list of SVG filters, attach filters to art, and manipulate art with SVG filters attached.

Although AISVGFilterHandles are reference counted objects this suite does not increment the reference count before returning it to you as with other reference counted objects.

These notifiers are associated with SVG filters:
kAISVGFilterChangedNotifier
kAISVGFilterAddedNotifier

These error codes are associated with SVG filters:
kXMLIDCollisionErr
kXMLIDChangedErr
kNoSVGFilterErr
kSVGFilterRedefErr

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAISVGFilterSuite and kAISVGFilterVersion.

---

Member Data Documentation

AIAPI AIErr(* AISVGFilterSuite::AttachFilter)(AIArtHandle art, AISVGFilterHandle filter)

Applies an SVG filter to artwork.

Parameters:

	art	The artwork.
	filter	The SVG filter.

AIAPI AIErr(* AISVGFilterSuite::CountSVGFilters)(ai::int32 *count)

Gets the number of SVG filters in the current document.

Use with GetNthSVGFilter() to iterate through filters.

Parameters:

count

[out] A buffer in which to return the count.

AIAPI AIErr(* AISVGFilterSuite::DeleteSVGFilter)(AISVGFilterHandle filter)

Deletes an SVG filter from the current document.

Parameters:

filter

The filter.

AIAPI AIErr(* AISVGFilterSuite::DisposeFilterArt)(AIArtHandle art)

Disposes of the input/output art for an SVG filter, as returned by GetSVGFilterArt().

Parameters:

art

The SVG art.

AIAPI AIErr(* AISVGFilterSuite::GetNthSVGFilter)(ai::int32 n, AISVGFilterHandle *filter)

Retrieves an SVG filter from the filter list for the current document.

Use with CountSVGFilters() to iterate through filters.

Parameters:

	n	The 0-based position index.
	filter	[out] A buffer in which to return the filter.

AIAPI AIErr(* AISVGFilterSuite::GetSVGFilter)(const ai::UnicodeString &name, AISVGFilterHandle *filter)

Retrieves the filter handle associated with an identifying name string.

Parameters:

	name	The name string.
	filter	[out] A buffer in which to return the filter.

AIAPI AIErr(* AISVGFilterSuite::GetSVGFilterArt)(AIArtHandle art, AIArtHandle *svgArt)

Retrieves a copy of art that is used for an SVG Filter Effect on the specified art object.

Parameters:

	art	The input art object.
	svgArt	[out] A buffer in which to return a copy of the SVG filter art, or null if there is no SVG Filter Effect attached to the input art object. You are responsible for freeing this copy using DisposeFilterArt().

AIAPI AIErr(* AISVGFilterSuite::GetSVGFilterContents)(AISVGFilterHandle filter, AIXMLNodeRef *filterContents)

Retrieves the contents of an SVG filter.

Parameters:

	filter	The SVG filter.
	filterContents	[out] A buffer in which to return the XML node containing the contents.

AIAPI AIErr(* AISVGFilterSuite::GetSVGFilterUIDName)(AISVGFilterHandle filter, ai::UnicodeString &name)

Retrieves the identifying name string for a filter handle,.

Parameters:

	filter	The SVG filter.
	name	[out] A buffer in which to return the name string.

AIAPI AIErr(* AISVGFilterSuite::NewSVGFilter)(AISVGFilterHandle *newFilter)

Creates a new SVG filter in the current document.

Parameters:

newFilter

[out] A buffer in which to return the new filter.

AIAPI AIErr(* AISVGFilterSuite::SetSVGFilterContents)(AISVGFilterHandle filter, AIXMLNodeRef filterContents, AIBool8 forceUniqueID)

Sets the contents of an SVG filter.

Parameters:

	filter	The SVG filter.
	filterContents	The XML node containing the new contents.
	forceUniqueID	True to rename the filter to have a unique identifier, if necessary. Retrieve the XML identifier from the filter object with GetSVGFilterUIDName())

Returns:

kXMLIDCollisionErr error if forceUniqueID is false, and if The XML identifier is already in use in the current document.
kXMLIDChangedErr if forceUniqueID is true and the XML identifier was changed to make it unique.

AIAPI AIErr(* AISVGFilterSuite::SVGFilterFromAIArtStyle)(const AIArtStyleHandle artStyle, AISVGFilterHandle *filter)

Generates an SVG filter to represent an art style, if possible.

Parameters:

	artStyle	The art style object.
	filter	[out] A buffer in which to return the SVG filter.

Returns:

kNoSVGFilterErr error if the style cannot be represented as SVG.

---

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

• AISVGFilter.h