idomglyph.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2007-2026 Hybrid Software Helix Ltd. All rights reserved.
 */
 
#ifndef EDLIDOMGLYPH_H
#define EDLIDOMGLYPH_H
 
#include <edl/edltypes.h>
#include <edl/edlgeom.h>
#include <edl/idomnode.h>
 
_BEGIN_EDL_DOM_NAMESPACE
 
class IDOMGlyphName;
DECL_SMART_PTR(IDOMGlyphName);

class IDOMGlyphName : public IRCObject
{
  public:
    virtual ~IDOMGlyphName() {}
 
    static EDL_API IDOMGlyphNamePtr create(IEDLClassFactory *pFactory, const EDLSysString &glyphName);
 
    virtual const EDLSysString &getNameString() const = 0;
};
 
class IDOMGlyph;
DECL_SMART_PTR(IDOMGlyph);
#define edlobj2IDOMGlyph(src) edl_cast((IDOMGlyph *)NULL, src)
#define dom2IDOMGlyph(src) dom2NodeType<IDOMGlyph, eDOMGlyphNode>(src)
typedef CEDLVector<IDOMGlyphPtr> CDOMGlyphVect;

class IDOMGlyph : public IDOMNode
{
#define IDOMGlyphClassID 0x0dcbbdbd, 0xa6ee4a4a, 0x93843fd9, 0xcd134e05
  public:

    typedef uint16 GlyphID;

    typedef enum {
 
        eGlyphIDNotdef  = 0     
 
    } eGlyphIDSpecial;

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

    class Data : public CClassParams
    {
      public:
        Data(): hasCustomAdvance(false), advanceX(0.0), advanceY(0.0),
            uOffset(0.0), vOffset(0.0), glyphID(0), originalAdvanceX(0.0)
        {
            colored = false;
            bounds.setEmpty();
        }
        bool             hasCustomAdvance;
        double           advanceX;
        double           advanceY;
        double           uOffset;
        double           vOffset;
        EDLU32String     unicode;
        GlyphID          glyphID;
        IDOMGlyphNamePtr glyphName;
        FRect            bounds;
        bool             colored;
        double           originalAdvanceX;
 
        bool operator== (const Data &other) const
        {
            bool bEq =  (other.hasCustomAdvance     == hasCustomAdvance)
                    &&  (other.uOffset              == uOffset)
                    &&  (other.vOffset              == vOffset)
                    &&  (other.unicode              == unicode)
                    &&  (other.glyphID              == glyphID)
                    &&  (other.glyphName            == glyphName)
                    &&  (other.bounds               == bounds)
                    &&  (other.colored              == colored)
                    &&  (other.originalAdvanceX     == originalAdvanceX);
 
            if (bEq && hasCustomAdvance)
                bEq  =  (other.advanceX             == advanceX)
                    &&  (other.advanceY             == advanceY);
 
            return bEq;
        }
 
        bool operator!= (const Data &other) const
        {
            return ! (*this == other);
        }
    };
 
    typedef CEDLVector<Data> CDOMGlyphDataVect;

    static EDL_API IDOMGlyphPtr create(IEDLClassFactory *pFactory, const IDOMGlyph::Data &params);

    static EDL_API IDOMGlyphPtr create(IEDLClassFactory *pFactory,
                                       bool hasCustomAdvance,
                                       double advanceX,
                                       double advanceY,
                                       double uOffset,
                                       double vOffset,
                                       const EDLU32String &unicode,
                                       IDOMGlyph::GlyphID glyphID,
                                       const IDOMGlyphNamePtr &glyphName,
                                       const FRect bounds,
                                       bool colored,
                                       double originalAdvanceX);

    virtual bool getHasCustomAdvance() const = 0;

    virtual void setHasCustomAdvance(bool bHasCustomAdvance) = 0;

    virtual GlyphID getGlyphID() const = 0;
 
#ifdef SWIG
    %apply uint32_t &OUTPUT { uint32 &codePoint };
#endif
    virtual bool  getGlyphUnicode(uint32 &codePoint) const = 0;
#ifdef SWIG
    %clear uint32 &codePoint;
#endif

    virtual const EDLU32String &getGlyphUnicode() const = 0;

    virtual bool getGlyphName(EDLSysString &glyphName) = 0;

    virtual IDOMGlyphNamePtr getGlyphName() const = 0;
 
    /* All measurements are as if the font rendering em size is '1'
    * So, you need to scale them yourself!
    */

    virtual double getAdvanceX() const = 0;

    virtual double getAdvanceY() const = 0;

    virtual double getUOffset() const = 0;

    virtual double getVOffset() const = 0;

    virtual FRect getBounds() const = 0;

    virtual void setColored (bool bColored) = 0;

    virtual bool getColored () const = 0;

    virtual double getOriginalAdvanceX() const = 0;
};
 

class IDOMGlyphIDEnumerator  :  public IEDLObject
{
#define IDOMGlyphIDEnumeratorClassID 0x637f8550, 0xdb1511dc, 0x95ff0800, 0x200c9a66
public:

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

    virtual void add(IDOMGlyph::GlyphID glyphID) = 0;

    virtual IDOMGlyph::GlyphID getGlyphID() = 0;

    virtual bool beginEnumeration() = 0;

    virtual bool endEnumeration() = 0;

    virtual bool nextEnumerationItem() = 0;
 
};
 
DECL_SMART_PTR(IDOMGlyphIDEnumerator);
 
 
_END_EDL_DOM_NAMESPACE
 
#endif /* __EDLIDOMGLYPH_H__ */