API: AIArtSetGenerator.h Source File

00001 /*************************************************************************
00002 *
00003 * ADOBE CONFIDENTIAL
00004 * 
00005 * Copyright 2017 Adobe
00006 * 
00007 * All Rights Reserved.
00008 *
00009 * NOTICE: Adobe permits you to use, modify, and distribute this file in
00010 * accordance with the terms of the Adobe license agreement accompanying
00011 * it. If you have received this file from a source other than Adobe,
00012 * then your use, modification, or distribution of it requires the prior
00013 * written permission of Adobe.
00014 *
00015 **************************************************************************/
00016 
00017 #pragma once
00018 
00019 #include "AIArtSet.h"
00020 #include "AIArtboard.h"
00021 #include "AIHeaderBegin.h"
00022 
00025 /*******************************************************************************
00026  **
00027  **     Constants
00028  **
00029  **/
00030 
00031 #define kAIArtSetGeneratorSuite                         "AI Art Set Generator Suite"
00032 #define kAIArtSetGeneratorSuiteVersion3         AIAPI_VERSION(3)
00033 #define kAIArtSetGeneratorSuiteVersion          kAIArtSetGeneratorSuiteVersion3
00034 #define kAIArtSetGeneratorVersion                       kAIArtSetGeneratorSuiteVersion
00035 
00036 /*******************************************************************************
00037  **
00038  **     Suite
00039  **
00040  **/
00041 
00042 
00043 struct AIArtSetGeneratorSuite
00044 {
00047         AIAPI AIErr (*GenerateForAllLayers) ( AIArtSet outArtSet );
00048 
00052         AIAPI AIErr (*GenerateForNthLayer) ( ai::int32 inLayerIndex,
00053                                                                                         AIArtSet outArtSet );
00054 
00058         AIAPI AIErr (*GenerateForNamedLayer) ( const ai::UnicodeString& inLayerName,
00059                                                                                         AIArtSet outArtSet );
00060 
00064         AIAPI AIErr (*GenerateForNthArtboard) ( ai::ArtboardID inArtboardIndex,
00065                                                                                         AIArtSet outArtSet, AIBoolean skipHiddenArts );
00066 
00070         AIAPI AIErr (*GenerateForNamedArtboard) ( const ai::UnicodeString& inArtboardName,
00071                                                                                                 AIArtSet outArtSet, AIBoolean skipHiddenArts );
00072 
00076         AIAPI AIErr (*GenerateForTopLevelLayers) ( AIArtSet outArtSet, AIBoolean skipHiddenLayers );
00077 
00082         AIAPI AIErr (*GenerateSelectedAtTopLevel) ( AIArtSet outArtSet );
00083 
00092         AIAPI AIErr (*GenerateNSelectedAtTopLevel) ( size_t inMaxSelectedArtsToReturn,
00093                                                                                                         AIArtSet outArtSet,
00094                                                                                                         AIBoolean *outHasMoreSelectedArts );
00095 
00098     AIAPI AIErr (*GenerateForArt) (AIArtHandle inArt, AIArtSet outArtSet);
00099 
00100 };
00101 
00102 #include "AIHeaderEnd.h"