idomcolor.h

Go to the documentation of this file.

/*
* Copyright (C) 2007-2025 Global Graphics Software Ltd. All rights reserved.
*/
 
#ifndef EDLIDOMCOLOR_H
#define EDLIDOMCOLOR_H
 
#include <edl/edlrenderingintent.h>
#include <edl/edlblackpointcompensation.h>
#include <edl/edltypes.h>
#include <edl/iedlobject.h>
#include <edl/icolormanager.h>
#include <edl/idomcolorspace.h>
#include <edl/idomresources.h>
#include <edl/idomhashable.h>
#include <edl/edlvector.h>
 
_BEGIN_EDL_DOM_NAMESPACE
 
class IDOMColor;
DECL_SMART_PTR(IDOMColor);
 

class IDOMColor : public IEDLObject, public IDOMHashable
{
#define IDOMColorClassID 0x4a33f930, 0xc5d64967, 0xaa600a12, 0x78eb3212
  public:
 
    virtual ~IDOMColor ()
    {}

    static IDOMColorPtr createSolidGray(IEDLClassFactory *pFactory, float gray = 0.0f)
    {
        return IDOMColor::create(pFactory, IDOMColorSpaceDeviceGray::create(pFactory), 1.0f, gray);
    }

    static IDOMColorPtr createSolidRgb(IEDLClassFactory *pFactory, float r = 0.0f, float g = 0.0f, float b = 0.0f)
    {
        return IDOMColor::create(pFactory, IDOMColorSpaceDeviceRGB::create(pFactory), 1.0f, r, g, b);
    }

    static IDOMColorPtr createSolidCmyk(IEDLClassFactory *pFactory, float c = 0.0f, float m = 0.0f, float y = 0.0f, float k = 0.0f)
    {
        return IDOMColor::create(pFactory, IDOMColorSpaceDeviceCMYK::create(pFactory), 1.0f, c, m, y, k);
    }

    static EDL_API IDOMColorPtr create(IEDLClassFactory *pFactory, const IDOMColorSpacePtr &space, double alpha, double component);

    static EDL_API IDOMColorPtr create(IEDLClassFactory *pFactory, const IDOMColorSpacePtr &space, double alpha, double component1, double component2);

    static EDL_API IDOMColorPtr create(IEDLClassFactory *pFactory, const IDOMColorSpacePtr &space, double alpha, double component1, double component2, double component3);

    static EDL_API IDOMColorPtr create(IEDLClassFactory *pFactory, const IDOMColorSpacePtr &space, double alpha, double component1, double component2, double component3, double component4);

    static EDL_API IDOMColorPtr create(IEDLClassFactory *pFactory, const IDOMColorSpacePtr &space, double alpha, double component1, double component2, double component3, double component4, double component5);

    static EDL_API IDOMColorPtr create(IEDLClassFactory *pFactory, const IDOMColorSpacePtr &space, double alpha, double component1, double component2, double component3, double component4, double component5, double component6);

    static EDL_API IDOMColorPtr create(IEDLClassFactory *pFactory, const IDOMColorSpacePtr &space, double alpha,
                                       double component1,        double component2,        double component3,        double component4,        double component5,
                                       double component6,        double component7,        double component8  = 0.0, double component9  = 0.0, double component10 = 0.0,
                                       double component11 = 0.0, double component12 = 0.0, double component13 = 0.0, double component14 = 0.0, double component15 = 0.0,
                                       double component16 = 0.0, double component17 = 0.0, double component18 = 0.0, double component19 = 0.0, double component20 = 0.0,
                                       double component21 = 0.0, double component22 = 0.0, double component23 = 0.0, double component24 = 0.0, double component25 = 0.0,
                                       double component26 = 0.0, double component27 = 0.0, double component28 = 0.0, double component29 = 0.0, double component30 = 0.0,
                                       double component31 = 0.0, double component32 = 0.0
                                    );

    static EDL_API IDOMColorPtr createFromVect(IEDLClassFactory *pFactory, const IDOMColorSpacePtr &space, float alpha, const CEDLVector<float> &components);
 
#ifdef SWIG
#if SWIGJAVA
    %apply float[] { const float *components };
#endif
#if SWIGCSHARP
    %apply float INPUT [] { const float *components };
#endif
#endif
    static EDL_API IDOMColorPtr createFromArray(IEDLClassFactory *pFactory, const IDOMColorSpacePtr &space, float alpha, const float *components);
#ifdef SWIG
    %clear const float *components;
#endif

    static const CClassID &classID()
    {
        static CClassID id(IDOMColorClassID);
        return id;
    };

    virtual float getAlpha() const = 0;

    virtual void setAlpha(float a) = 0;

    virtual IDOMColorSpacePtr getColorSpace () = 0;

    virtual void setColorSpace(const IDOMColorSpacePtr &colorSpace, bool setDefaultColor = true) = 0;

    virtual void setColorSpace(const IDOMColorSpacePtr &colorSpace,
                               eRenderingIntent intent,
                               eBlackPointCompensation bpc,
                               IEDLClassFactory *pFactory,
                               const CColorManagerConfigPtr &overrideConfig = CColorManagerConfigPtr()) = 0;

    virtual float getComponentValue(uint32 component) = 0;

    virtual void setComponentValue(uint32 component, float value) = 0;

    virtual bool testGamut(IEDLClassFactory *pFactory,
                           const IDOMColorSpacePtr &colorSpace,
                           eRenderingIntent intent,
                           eBlackPointCompensation bpc,
                           const CColorManagerConfigPtr &overrideConfig = CColorManagerConfigPtr()) = 0;
 
};
#define edlobj2IDOMColor(src) edl_cast((IDOMColor *)NULL, src)
 
 
_END_EDL_DOM_NAMESPACE
 
#endif /* __EDLIDOMCOLOR_H__ */