Custom Platform Support Development Kit  1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
ITimelineBuilder.h
Go to the documentation of this file.
1 /******************************************************************************
2 * ADOBE CONFIDENTIAL
3 * ___________________
4 *
5 * Copyright [2013] Adobe Systems Incorporated
6 * All Rights Reserved.
7 *
8 * NOTICE: All information contained herein is, and remains
9 * the property of Adobe Systems Incorporated and its suppliers,
10 * if any. The intellectual and technical concepts contained
11 * herein are proprietary to Adobe Systems Incorporated and its
12 * suppliers and are protected by all applicable intellectual
13 * property laws, including trade secret and copyright laws.
14 * Dissemination of this information or reproduction of this material
15 * is strictly forbidden unless prior written permission is obtained
16 * from Adobe Systems Incorporated.
17 ******************************************************************************/
18 
26 #ifndef ITIMELINE_BUILDER_H_
27 #define ITIMELINE_BUILDER_H_
28 
29 #include "FCMPreConfig.h"
30 #include "FCMPluginInterface.h"
31 #include "Utils/DOMTypes.h"
33 #include "IFrame.h"
34 
35 
36 /* -------------------------------------------------- Forward Decl */
37 
38 namespace DOM
39 {
40  namespace FrameElement
41  {
42  FORWARD_DECLARE_INTERFACE(IMovieClip);
44  }
45 
47 }
48 
49 
50 /* -------------------------------------------------- Enums */
51 
52 
53 /* -------------------------------------------------- Macros / Constants */
54 
55 namespace Exporter
56 {
57  namespace Service
58  {
66  {0xe1fa4e28, 0x3a46, 0x4106, {0xbc, 0xdb, 0xf, 0x46, 0x5b, 0x1f, 0xd4, 0x62}};
67  }
68 }
69 
70 
71 /* -------------------------------------------------- Structs / Unions */
72 
73 namespace Exporter
74 {
75  namespace Service
76  {
82  struct SOUND_INFO
83  {
85  size_t structSize;
86 
89  };
90 
91 
99  {
101  size_t structSize;
102 
105 
111 
114  };
115 
126  {
129  };
130 
138 
139 
147 
148 
156 
157 
165 
166 
174 
183  }
184 }
185 
186 
187 /* -------------------------------------------------- Class Decl */
188 
189 namespace Exporter
190 {
191  namespace Service
192  {
201 
202 
213  virtual FCM::Result _FCMCALL AddShape(
214  FCM::U_Int32 objectId,
215  SHAPE_INFO* pShapeInfo) = 0;
216 
217 
229  virtual FCM::Result _FCMCALL AddClassicText(
230  FCM::U_Int32 objectId,
231  CLASSIC_TEXT_INFO* pClassicTextInfo) = 0;
232 
233 
245  virtual FCM::Result _FCMCALL AddBitmap(
246  FCM::U_Int32 objectId,
247  BITMAP_INFO* pBitmapInfo) = 0;
248 
249 
264  virtual FCM::Result _FCMCALL AddMovieClip(
265  FCM::U_Int32 objectId,
266  MOVIE_CLIP_INFO* pMovieClipInfo,
267  DOM::FrameElement::PIMovieClip pMovieClip) = 0;
268 
269 
281  virtual FCM::Result _FCMCALL AddGraphic(
282  FCM::U_Int32 objectId,
283  GRAPHIC_INFO* pGraphicInfo) = 0;
284 
285 
300  virtual FCM::Result _FCMCALL AddSound(
301  FCM::U_Int32 objectId,
302  SOUND_INFO* pSoundInfo,
303  DOM::FrameElement::PISound pSound) = 0;
304 
305 
319  virtual FCM::Result _FCMCALL UpdateZOrder(
320  FCM::U_Int32 objectId,
321  FCM::U_Int32 placeAfterObjectId) = 0;
322 
323 
332  virtual FCM::Result _FCMCALL Remove(FCM::U_Int32 objectId) = 0;
333 
334 
347  virtual FCM::Result _FCMCALL UpdateBlendMode(
348  FCM::U_Int32 objectId,
349  DOM::FrameElement::BlendMode blendMode) = 0;
350 
351 
363  virtual FCM::Result _FCMCALL UpdateVisibility(
364  FCM::U_Int32 objectId,
365  FCM::Boolean visible) = 0;
366 
367 
380  virtual FCM::Result _FCMCALL UpdateGraphicFilter(
381  FCM::U_Int32 objectId,
382  PIFCMList pFilterable) = 0;
383 
384 
397  virtual FCM::Result _FCMCALL UpdateDisplayTransform(
398  FCM::U_Int32 objectId,
399  const DOM::Utils::MATRIX2D& matrix) = 0;
400 
401 
414  virtual FCM::Result _FCMCALL UpdateColorTransform(
415  FCM::U_Int32 objectId,
416  const DOM::Utils::COLOR_MATRIX& colorMatrix) = 0;
417 
418 
426  virtual FCM::Result _FCMCALL ShowFrame() = 0;
427 
428 
445  virtual FCM::Result _FCMCALL AddFrameScript(FCM::CStringRep16 pScript, FCM::U_Int32 layerNum) = 0;
446 
447 
456  virtual FCM::Result _FCMCALL RemoveFrameScript(FCM::U_Int32 layerNum) = 0;
457 
458 
474  virtual FCM::Result _FCMCALL SetFrameLabel(FCM::StringRep16 pLabel, DOM::KeyFrameLabelType labelType) = 0;
475 
477 
478  }
479 }
480 
481 
482 /* -------------------------------------------------- Inline / Functions */
483 
484 
485 #include "FCMPostConfig.h"
486 
487 #endif // ITIMELINE_BUILDER_H_
488 
DISPLAY_OBJECT_INFO BITMAP_INFO
This structure contains placement information about a bitmap object on the stage. ...
Definition: ITimelineBuilder.h:146
#define FORWARD_DECLARE_INTERFACE(ifx)
Used to forward declare an interface ifx.
Definition: FCMMacros.h:114
unsigned _int32 U_Int32
Type to define an unsigned 32-bit value.
Definition: FCMTypes.h:81
#define BEGIN_DECLARE_INTERFACE(ifx, iid)
Used to begin the interface ifx with ID iid, which inherits from IFCMUnknown.
Definition: FCMMacros.h:147
The definitions contained in this namespace define a framework called Flash Component Model (FCM)...
Definition: IGroup.h:36
DISPLAY_OBJECT_INFO CLASSIC_TEXT_INFO
This structure contains placement information about a text object on the stage.
Definition: ITimelineBuilder.h:155
This file contains the interface for IMovieClip. IMovieClip interface represents a "MovieClip" symbol...
This file contains the interface for IFrame. The IFrame interface represents a frame in the layer of ...
DOM::Utils::MATRIX2D matrix
Definition: ITimelineBuilder.h:113
Defines a rectangle.
Definition: DOMTypes.h:269
U_Int16 * StringRep16
Used to define a UTF16 (unicode) encoded string.
Definition: FCMTypes.h:161
This structure contains placement information about a display object on the stage, that are not present in DISPLAY_OBJECT_INFO Given a DISPLAY_OBJECT_INFO pointer pDisplayObjectInfo, access the fields in this structure only if the condition (pDisplayObjectInfo->structSize >= sizeof(DISPLAY_OBJECT_INFO_2)) is true.
Definition: ITimelineBuilder.h:125
DISPLAY_OBJECT_INFO GRAPHIC_INFO
This structure contains placement information about a graphic object on the stage.
Definition: ITimelineBuilder.h:173
Provides interfaces and other definitions to access the FLA authored contents in the form of a DOM (D...
FCM::U_Int32 resourceId
Definition: ITimelineBuilder.h:88
U_Int8 Boolean
Type to define a boolean.
Definition: FCMTypes.h:140
This file contains core definitions of the framework Flash Component Model (FCM). ...
DOM::Utils::RECT bounds
Definition: ITimelineBuilder.h:128
#define _FCMCALL
Defines calling convention for interface methods.
Definition: FCMMacros.h:176
Represents a transformation matrix.
Definition: DOMTypes.h:199
This file contains the types used for DOM traversal and access.
U_Int32 Result
Type to define a result. This is usually the return type for most APIs.
Definition: FCMTypes.h:126
Represents a 128 bit or 16-byte GUID (Globally Unique IDentifier) value.
Definition: FCMTypes.h:189
Provides interfaces for exporter that can be used by custom publisher.
const U_Int16 * CStringRep16
Used to define a constant UTF16 (unicode) encoded string.
Definition: FCMTypes.h:168
DISPLAY_OBJECT_INFO SHAPE_INFO
This structure contains placement information about a shape object on the stage.
Definition: ITimelineBuilder.h:137
size_t structSize
Definition: ITimelineBuilder.h:85
This structure contains information about a sound object in the timeline.
Definition: ITimelineBuilder.h:82
size_t structSize
Definition: ITimelineBuilder.h:101
DISPLAY_OBJECT_INFO_2 CLASSIC_TEXT_INFO_2
This structure contains a few more placement information about a text object in addition to containin...
Definition: ITimelineBuilder.h:182
This interface represents a builder for a timeline. Timeline builder contains methods that are invoke...
Definition: ITimelineBuilder.h:200
FCM::U_Int32 placeAfterObjectId
Definition: ITimelineBuilder.h:110
FCM::ConstFCMIID IID_ITIMELINE_BUILDER
Defines the universally-unique interface ID for ITimelineBuilder.
Definition: ITimelineBuilder.h:65
BlendMode
Defines the different Blend modes available for the MovieClip instance.
Definition: IMovieClip.h:54
KeyFrameLabelType
Defines the types of frames.
Definition: IFrame.h:55
#define END_DECLARE_INTERFACE
Ends an interface.
Definition: FCMMacros.h:165
This structure contains placement information about a display object on the stage.
Definition: ITimelineBuilder.h:98
FCM::U_Int32 resourceId
Definition: ITimelineBuilder.h:104
DISPLAY_OBJECT_INFO MOVIE_CLIP_INFO
This structure contains placement information about a movie-clip object on the stage.
Definition: ITimelineBuilder.h:164