hdicoreLiveEffect.h

Go to the documentation of this file.

 
#ifndef __HDI_CORE_LIVE_EFFECT__
#define __HDI_CORE_LIVE_EFFECT__
 
#if defined(HDI_CORE_AIP_MODE)
 
#include "hdicorePathStyle.h"
#include "hdicoreTransformMatrix.h"
#include "hdicoreTypes.h"
 
namespace hdi
{
    namespace core
    {
        class LiveEffect
        {
            public:
                class Parameters
                {
                    public:
                        Parameters();
                    
                        Parameters(const Parameters& p_);

                        virtual ~Parameters();
                        
                        virtual Parameters& operator=(const Parameters& rhs_);

                        virtual bool isEmpty() const;

                        virtual AILiveEffectParameters aiLiveEffectParams() const;
                        
                        virtual bool operator==(const Parameters& rhs_) const;
                        
                        virtual bool operator!=(const Parameters& rhs_) const;
                        
                        virtual std::string displayString() const;
                        
                        virtual std::string extraString() const;
                        
                        virtual bool fillStyle(FillStyle& fs__) const;
                    
                        virtual bool fillStyleMatrix(TransformMatrix& m__) const;
                    
                        virtual bool xformedFillStyle(FillStyle& fs__) const;
                        
                        virtual bool strokeStyle(StrokeStyle& ss__) const;
                    
                        virtual bool strokeStyleMatrix(TransformMatrix& m__) const;
                        
                        virtual bool xformedStrokeStyle(StrokeStyle& ss__) const;

                        virtual bool evenOdd() const;
                        
                        virtual double scaleFactor() const;
 
 
                    private:
                        friend void* __accessImpl(const Parameters&);
                        friend Parameters __accessCtor(AILiveEffectParameters);

                        void* __data;
                        
                        void* __impl() const;

                        Parameters(AILiveEffectParameters);
                };
        
                typedef std::unique_ptr<Parameters> ParametersUP;
                typedef std::shared_ptr<Parameters> ParametersSP;
                typedef std::weak_ptr<Parameters> ParametersWP;
                
                enum PreferredInputArtType
                {
                    InputArtTypeDynamic         = 0,
                    InputArtTypeGroup           = 1 << 0,
                    InputArtTypePath            = 1 << 1,
                    InputArtTypeCompoundPath    = 1 << 2,
                    InputArtTypePlaced          = 1 << 3,
                    InputArtTypeRaster          = 1 << 4,
                    InputArtTypeCustom          = 1 << 5,
                    InputArtTypeMesh            = 1 << 6,
                    InputArtTypeText            = 1 << 7,
                    InputArtTypeSymbol          = 1 << 8,
                    InputArtTypeForeign         = 1 << 9,
                    InputArtTypeTextLegacy      = 1 << 10,
                    InputArtTypeAll             = ~0L
                };
                
                enum StyleFlags
                {
                    NoStyleFlags            = 0,
                    
                    // Applied by default before the object is painted with fill or stroke
                    PreEffectFilter         = 1,
                    
                    // Applied by default after the object is painted with fill or stroke
                    PostEffectFilter        = 2,
                    
                    // Replaces the default stroke behavior. Brushes are an example of an effect of this type.
                    StrokeFilter            = 3,
                    
                    // Replaces the default fill behavior
                    FillFilter              = 4,
                    
                    // A mask to OR with the filter-style value to retrieve specific bit flags. Don't use when
                    // registering a live effect.
                    FilterTypeMask          = 0xFFFF,
                    
                    // Parameters can be scaled
                    HasScalableParams       = 1 << 17,
                    
                    // Supports automatic rasterization
                    UsesAutoRasterize       = 1 << 18,
                    
                    // Supports the generation of an SVG filter
                    CanGenerateSVGFilter    = 1 << 19,
                    
                    // Has parameters that can be modified by a LiveEffectAdjustColorsMessageType message
                    HandlesAdjustColorMsg   = 1 << 20,
                    
                    // Handles LiveEffectIsCompatibleMessageType messages. If this flag is not set the message will not
                    // be sent.
                    HandlesIsCompatibleMsg  = 1 << 21
                };
                
                enum MergeAction
                {
                    UnknownMergeAction          = 0,
                    AppendMergeAction           = 10,
                    ReplaceFillMergeAction      = 20,
                    ReplaceStrokeMergeAction    = 30
                };

                LiveEffect();
            
                LiveEffect(const LiveEffect& le_);

                LiveEffect(const AILiveEffectHandle aiLiveEff_);

                virtual ~LiveEffect();
                
                virtual LiveEffect& operator=(const LiveEffect& rhs_);

                virtual bool isEmpty() const;

                virtual AILiveEffectHandle aiLiveEffectHandle() const;
                
                virtual bool operator==(const LiveEffect& rhs_) const;
                
                virtual bool operator!=(const LiveEffect& rhs_) const;
                
                virtual std::string name() const;
                
                virtual std::string title() const;
                
                virtual bool version(int32_t& major__, int32_t& minor__) const;

                virtual PreferredInputArtType inputArtPreference() const;

                virtual StyleFlags styleFlags() const;

                virtual bool mergeIntoSelection(const MergeAction act_);

                virtual bool getEarliestAppVersion(int16_t& rgbVers__, int16_t& cmykVers__) const;

                virtual void setEarliestAppVersion(const int16_t rgbVers_, const int16_t cmykVers_);
 
 
            private:
                friend void* __accessImpl(const LiveEffect&);

                void* __data;
                
                void* __impl() const;
        };
        
        typedef std::unique_ptr<LiveEffect> LiveEffectUP;
        typedef std::shared_ptr<LiveEffect> LiveEffectSP;
        typedef std::weak_ptr<LiveEffect> LiveEffectWP;
        
        extern void* __accessImpl(const LiveEffect::Parameters&);
        extern LiveEffect::Parameters __accessCtor(AILiveEffectParameters);
        extern void* __accessImpl(const LiveEffect&);
    }
}
 
hdi::core::LiveEffect::PreferredInputArtType operator|(
    const hdi::core::LiveEffect::PreferredInputArtType lhs_,
    const hdi::core::LiveEffect::PreferredInputArtType rhs_
);
 
hdi::core::LiveEffect::PreferredInputArtType& operator|=(
    hdi::core::LiveEffect::PreferredInputArtType& lhs__,
    const hdi::core::LiveEffect::PreferredInputArtType rhs_
);
 
#endif
// HDI_CORE_AIP_MODE
 
#endif
// __HDI_CORE_LIVE_EFFECT__