ITimelineBuilder.h

Go to the documentation of this file.

/******************************************************************************
* ADOBE CONFIDENTIAL
* ___________________
*
*  Copyright [2013] Adobe Systems Incorporated
*  All Rights Reserved.
*
* NOTICE:  All information contained herein is, and remains
* the property of Adobe Systems Incorporated and its suppliers,
* if any.  The intellectual and technical concepts contained
* herein are proprietary to Adobe Systems Incorporated and its
* suppliers and are protected by all applicable intellectual 
* property laws, including trade secret and copyright laws.
* Dissemination of this information or reproduction of this material
* is strictly forbidden unless prior written permission is obtained
* from Adobe Systems Incorporated.
******************************************************************************/

#ifndef ITIMELINE_BUILDER_H_
#define ITIMELINE_BUILDER_H_

#include "FCMPreConfig.h"
#include "FCMPluginInterface.h"
#include "Utils/DOMTypes.h"
#include "FrameElement/IMovieClip.h"
#include "IFrame.h"


/* -------------------------------------------------- Forward Decl */

namespace DOM
{    
    namespace FrameElement
    {
        FORWARD_DECLARE_INTERFACE(IMovieClip);
        FORWARD_DECLARE_INTERFACE(ISound);
    }

    FORWARD_DECLARE_INTERFACE(ITween);
}


/* -------------------------------------------------- Enums */


/* -------------------------------------------------- Macros / Constants */

namespace Exporter
{
    namespace Service
    {
        FCM::ConstFCMIID IID_ITIMELINE_BUILDER =
            {0xe1fa4e28, 0x3a46, 0x4106, {0xbc, 0xdb, 0xf, 0x46, 0x5b, 0x1f, 0xd4, 0x62}};
    }
}


/* -------------------------------------------------- Structs / Unions */

namespace Exporter
{
    namespace Service
    {
        struct SOUND_INFO
        {
            size_t                  structSize;

            FCM::U_Int32            resourceId;
        };


        struct DISPLAY_OBJECT_INFO
        {
            size_t                  structSize;

            FCM::U_Int32            resourceId;

            FCM::U_Int32            placeAfterObjectId;
            
            DOM::Utils::MATRIX2D    matrix;
        };
        

        typedef DISPLAY_OBJECT_INFO SHAPE_INFO;
        

        typedef DISPLAY_OBJECT_INFO BITMAP_INFO;


        typedef DISPLAY_OBJECT_INFO CLASSIC_TEXT_INFO;


        typedef DISPLAY_OBJECT_INFO MOVIE_CLIP_INFO;


        typedef DISPLAY_OBJECT_INFO GRAPHIC_INFO;
    }
}


/* -------------------------------------------------- Class Decl */

namespace Exporter
{
    namespace Service
    {
        BEGIN_DECLARE_INTERFACE(ITimelineBuilder, IID_ITIMELINE_BUILDER)

            
            virtual FCM::Result _FCMCALL AddShape(
                FCM::U_Int32 objectId, 
                SHAPE_INFO* pShapeInfo) = 0;

            
            virtual FCM::Result _FCMCALL AddClassicText(
                FCM::U_Int32 objectId, 
                CLASSIC_TEXT_INFO* pClassicTextInfo) = 0;
            
            
            virtual FCM::Result _FCMCALL AddBitmap(
                FCM::U_Int32 objectId, 
                BITMAP_INFO* pBitmapInfo) = 0;

            
            virtual FCM::Result _FCMCALL AddMovieClip(
                FCM::U_Int32 objectId, 
                MOVIE_CLIP_INFO* pMovieClipInfo, 
                DOM::FrameElement::PIMovieClip pMovieClip) = 0;
            
            
            virtual FCM::Result _FCMCALL AddGraphic(
                FCM::U_Int32 objectId, 
                GRAPHIC_INFO* pGraphicInfo) = 0;


            virtual FCM::Result _FCMCALL AddSound(
                FCM::U_Int32 objectId, 
                SOUND_INFO* pSoundInfo, 
                DOM::FrameElement::PISound pSound) = 0;

             
            virtual FCM::Result _FCMCALL UpdateZOrder(
                FCM::U_Int32 objectId, 
                FCM::U_Int32 placeAfterObjectId) = 0;


            virtual FCM::Result _FCMCALL Remove(FCM::U_Int32 objectId) = 0;


            virtual FCM::Result _FCMCALL UpdateBlendMode(
                FCM::U_Int32 objectId, 
                DOM::FrameElement::BlendMode blendMode) = 0;


            virtual FCM::Result _FCMCALL UpdateVisibility(
                FCM::U_Int32 objectId, 
                FCM::Boolean visible) = 0;


            virtual FCM::Result _FCMCALL UpdateGraphicFilter(
                FCM::U_Int32 objectId, 
                PIFCMList pFilterable) = 0;

            
            virtual FCM::Result _FCMCALL UpdateDisplayTransform(
                FCM::U_Int32 objectId, 
                const DOM::Utils::MATRIX2D& matrix) = 0;


            virtual FCM::Result _FCMCALL UpdateColorTransform(
                FCM::U_Int32 objectId, 
                const DOM::Utils::COLOR_MATRIX& colorMatrix) = 0;


            virtual FCM::Result _FCMCALL ShowFrame() = 0;  


            virtual FCM::Result _FCMCALL AddFrameScript(FCM::CStringRep16 pScript, FCM::U_Int32 layerNum) = 0;


            virtual FCM::Result _FCMCALL RemoveFrameScript(FCM::U_Int32 layerNum) = 0;

            
            virtual FCM::Result _FCMCALL SetFrameLabel(FCM::StringRep16 pLabel, DOM::KeyFrameLabelType labelType) = 0;

        END_DECLARE_INTERFACE

    }
}


/* -------------------------------------------------- Inline / Functions */


#include "FCMPostConfig.h"

#endif // ITIMELINE_BUILDER_H_