ai::ArtSet Class Reference

A stack based wrapper class over AIArtSetSuite and AIArtSetGeneratorSuite. More...

#include <IAIArtSet.hpp>

Classes
class	Impl
class	iterator
Public Member Functions
	ArtSet (bool fillWithSelectedArtObjects=false)
	Default constructor, fill with selected art objects when true is passed.
	ArtSet (AIArtHandle *artArray, size_t count)
	Create ArtSet from art handle array.
	ArtSet (AILayerHandle layer)
	Fill all objects from layer.
template<std::size_t N>
	ArtSet (const AIArtSpec(&specs)[N])
	Construct with spec array.
	ArtSet (const AIArtSpec &spec)
	Construct with one Spec.
	~ArtSet ()
AIErr	GenerateForAllLayers ()
	AIArtSetGeneratorSuite::GenerateForAllLayers()
AIErr	GenerateForNthLayer (ai::int32 inLayerIndex)
	AIArtSetGeneratorSuite::GenerateForNthLayer()
AIErr	GenerateForNamedLayer (const ai::UnicodeString &inLayerName)
	AIArtSetGeneratorSuite::GenerateForNamedLayer()
AIErr	GenerateForNthArtboard (ai::ArtboardID inArtboardIndex, bool skipHiddenArts)
	AIArtSetGeneratorSuite::GenerateForNthArtboard()
AIErr	GenerateForNamedArtboard (const ai::UnicodeString &inArtboardName, bool skipHiddenArts)
	AIArtSetGeneratorSuite::GenerateForNamedArtboard()
AIErr	GenerateForTopLevelLayers (bool skipHiddenLayers)
	AIArtSetGeneratorSuite::GenerateForTopLevelLayers()
AIErr	GenerateSelectedAtTopLevel ()
	AIArtSetGeneratorSuite::GenerateSelectedAtTopLevel()
AIErr	GenerateNSelectedAtTopLevel (size_t inMaxSelectedArtsToReturn, bool *outHasMoreSelectedArts)
	AIArtSetGeneratorSuite::GenerateNSelectedAtTopLevel()
AIErr	GenerateForArt (AIArtHandle inArt)
	Generates the ArtSet with the art provided.
size_t	size () const AINOEXCEPT
	Returns number of AIArtHandle in the ArtSet.
bool	empty () const AINOEXCEPT
	Returns true if ArtSet is empty.
value_type	at (size_t index) const
	Returns AIArtHandle stored in index.
value_type	operator[] (size_t index) const AINOEXCEPT
	Returns AIArtHandle stored in index.
void	insert (value_type art)
	Inserts into ArtSet if not already present.
void	erase (value_type art)
	Removes an AIArtHandle from ArtSet if present.
void	replace (value_type oldArt, value_type newArt)
	Replaces an AIArtHandle with another in the ArtSet.
void	clear ()
	Removes all elements from an ArtSet.
iterator	begin () const AINOEXCEPT
	Range iterator support.
iterator	end () const AINOEXCEPT
	Range iterator support.
iterator	rbegin () const AINOEXCEPT
	Reverse iterator support.
iterator	rend () const AINOEXCEPT
	Reverse iterator support.
void	swap (ArtSet &other) AINOEXCEPT
	Swaps the content with another ArtSet.
	operator bool () const AINOEXCEPT
	Returns true if the ArtSet has some elements and last call to fill ArtSet was successful.
AIErr	GetLastError () const AINOEXCEPT
	Returns the AIErr given back in the in last call to fill the ArtSet.
AIArtSet	get () const AINOEXCEPT
	Returns AIArtSet for APIs that need access to AIArtSet.
	ArtSet (ArtSet &&other) AINOEXCEPT
	Move constructor.
ArtSet &	operator= (ArtSet &&other) AINOEXCEPT
	Move assignment.

Detailed Description

A stack based wrapper class over AIArtSetSuite and AIArtSetGeneratorSuite.

Prefer this class over directly accessing the AIArtSetSuite/AIArtSetGeneratorSuite APIs.

Usage Examples:

Construction:

CAUTION: Constructor would throw if artSet was not constructed properly

1. Default Construct, creates an ai::ArtSet object, ready for actions such as insert, remove, and replace

ai::ArtSet artSet;

2. Construct an ai::ArtSet object, filled with all the selected art objects

ai::ArtSet artSet(true);

3. Construct an ai::ArtSet object, filled with all the objects on a layer

ai::ArtSet artSet(layerHandle);

4. Construct an ai::ArtSet object, filled with an existing array of AIArtHandle(s)

ai::ArtSet artSet(artHandles, count);

5. Construct an ai::ArtSet object, filled with all the art objects, matched to AIArtSpec

AIArtSpec spec = { kAnyArt, kArtFullySelected, kArtFullySelected }; ai::ArtSet artSet(spec);

6. Construct an ai::ArtSet object, filled with all the art objects matching an array of AIArtSpec

AIArtSpec specs = { {kRasterArt, kArtSelected, kArtSelected}, {kPlacedArt, kArtSelected, kArtSelected}, };

ai::ArtSet artSet(specs);

Query: Wraps all the query APIs from AIArtSetGeneratorSuite, few examples, 1. To create an ArtSet filled with all non-hidden objects on artboard 1

ai::ArtSet artSet auto err = artSet.GenerateForNthArtboard(1, true); for(auto art :artSet) { art }

2. To create an ArtSet filled with all objects on the 0th layer

ai::ArtSet artSet auto err = artSet.GenerateForNthLayer(0); for(auto art :artSet) { art }

Accessors: 1. C++ 11 range based loop

for(auto art : artSet) { access art }

2. reverse iterate

for (auto iter = artSet.rbegin(); iter != artSet.rend(); ++iter) { auto art = *iter; }

3. Get AIArtSet to be passed to APIs which need an AIArtSet

AIArtSet aiArtSet = artSet.get();

4. See if the last operation was successful, or the object was successfully constructed

if(artSet) { artSet was constructed successfully, proceed with other operations }

5. Need to pass the AIErr

AIErr err = artSet.GetLastError();

Mutators:

1. Insert an AIArtHandle

artSet.insert(art);

2. Remove an AIArtHandle

artSet.erase(art);

3. Replace an AIArtHandle with another

artSet.replace(oldArt, newArt);

4. Clear

artSet.clear();

Constructor & Destructor Documentation

ai::ArtSet::ArtSet ( bool fillWithSelectedArtObjects = false ) [explicit]

Default constructor, fill with selected art objects when true is passed.

Referenced by ArtSet().

ai::ArtSet::ArtSet	(	AIArtHandle *	artArray,
		size_t	count
	)			`[explicit]`

Create ArtSet from art handle array.

References AINOEXCEPT, ArtSet(), operator=(), swap(), and ~ArtSet().

ai::ArtSet::ArtSet ( AILayerHandle layer ) [explicit]

Fill all objects from layer.

template<std::size_t N>

ai::ArtSet::ArtSet ( const AIArtSpec(&) specs[N] ) [inline]

Construct with spec array.

ai::ArtSet::ArtSet ( const AIArtSpec & spec ) [inline]

Construct with one Spec.

ai::ArtSet::~ArtSet ( )

Referenced by ArtSet().

ai::ArtSet::ArtSet ( ArtSet && other )

Move constructor.

Member Function Documentation

ai::ArtSet::value_type ai::ArtSet::at ( size_t index ) const

Returns AIArtHandle stored in index.

Throws exception if out of bounds.

ArtSet::iterator ai::ArtSet::begin ( ) const

Range iterator support.

void ai::ArtSet::clear ( )

Removes all elements from an ArtSet.

bool ai::ArtSet::empty ( ) const [inline]

Returns true if ArtSet is empty.

References size().

ai::ArtSet::iterator ai::ArtSet::end ( ) const

Range iterator support.

References size().

void ai::ArtSet::erase ( value_type art )

Removes an AIArtHandle from ArtSet if present.

AIErr ai::ArtSet::GenerateForAllLayers ( )

AIArtSetGeneratorSuite::GenerateForAllLayers()

AIErr ai::ArtSet::GenerateForArt ( AIArtHandle inArt )

Generates the ArtSet with the art provided.

Traverses the art handle provided and fills the ArtSet with all the nested children of the group art. AIArtSetGeneratorSuite::GenerateForArt()

AIErr ai::ArtSet::GenerateForNamedArtboard	(	const ai::UnicodeString &	inArtboardName,
		bool	skipHiddenArts
	)

AIArtSetGeneratorSuite::GenerateForNamedArtboard()

AIErr ai::ArtSet::GenerateForNamedLayer ( const ai::UnicodeString & inLayerName )

AIArtSetGeneratorSuite::GenerateForNamedLayer()

AIErr ai::ArtSet::GenerateForNthArtboard	(	ai::ArtboardID	inArtboardIndex,
		bool	skipHiddenArts
	)

AIArtSetGeneratorSuite::GenerateForNthArtboard()

AIErr ai::ArtSet::GenerateForNthLayer ( ai::int32 inLayerIndex )

AIArtSetGeneratorSuite::GenerateForNthLayer()

AIErr ai::ArtSet::GenerateForTopLevelLayers ( bool skipHiddenLayers )

AIArtSetGeneratorSuite::GenerateForTopLevelLayers()

AIErr ai::ArtSet::GenerateNSelectedAtTopLevel	(	size_t	inMaxSelectedArtsToReturn,
		bool *	outHasMoreSelectedArts
	)

AIArtSetGeneratorSuite::GenerateNSelectedAtTopLevel()

AIErr ai::ArtSet::GenerateSelectedAtTopLevel ( )

AIArtSetGeneratorSuite::GenerateSelectedAtTopLevel()

AIArtSet ai::ArtSet::get ( ) const

Returns AIArtSet for APIs that need access to AIArtSet.

AIErr ai::ArtSet::GetLastError ( ) const

Returns the AIErr given back in the in last call to fill the ArtSet.

void ai::ArtSet::insert ( value_type art )

Inserts into ArtSet if not already present.

ai::ArtSet::operator bool ( ) const [explicit]

Returns true if the ArtSet has some elements and last call to fill ArtSet was successful.

ArtSet& ai::ArtSet::operator= ( ArtSet && other )

Move assignment.

Referenced by ArtSet().

ai::ArtSet::value_type ai::ArtSet::operator[] ( size_t index ) const

Returns AIArtHandle stored in index.

Returns nullptr if out of bounds.

ai::ArtSet::iterator ai::ArtSet::rbegin ( ) const

Reverse iterator support.

References size().

ai::ArtSet::iterator ai::ArtSet::rend ( ) const

Reverse iterator support.

void ai::ArtSet::replace	(	value_type	oldArt,
		value_type	newArt
	)

Replaces an AIArtHandle with another in the ArtSet.

size_t ai::ArtSet::size ( ) const

Returns number of AIArtHandle in the ArtSet.

Referenced by empty(), end(), and rbegin().

void ai::ArtSet::swap ( ArtSet & other )

Swaps the content with another ArtSet.

Referenced by ArtSet().

The documentation for this class was generated from the following files:

ai::ArtSet Class Reference

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation