attrbev.h

Go to the documentation of this file.

// $Id: attrbev.h 1282 2006-06-09 09:46:49Z alex $
/* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE
================================XARAHEADERSTART===========================
 
               Xara LX, a vector drawing and manipulation program.
                    Copyright (C) 1993-2006 Xara Group Ltd.
       Copyright on certain contributions may be held in joint with their
              respective authors. See AUTHORS file for details.

LICENSE TO USE AND MODIFY SOFTWARE
----------------------------------

This file is part of Xara LX.

Xara LX is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 as published
by the Free Software Foundation.

Xara LX and its component source files are distributed in the hope
that it will be useful, but WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with Xara LX (see the file GPL in the root directory of the
distribution); if not, write to the Free Software Foundation, Inc., 51
Franklin St, Fifth Floor, Boston, MA  02110-1301 USA


ADDITIONAL RIGHTS
-----------------

Conditional upon your continuing compliance with the GNU General Public
License described above, Xara Group Ltd grants to you certain additional
rights. 

The additional rights are to use, modify, and distribute the software
together with the wxWidgets library, the wxXtra library, and the "CDraw"
library and any other such library that any version of Xara LX relased
by Xara Group Ltd requires in order to compile and execute, including
the static linking of that library to XaraLX. In the case of the
"CDraw" library, you may satisfy obligation under the GNU General Public
License to provide source code by providing a binary copy of the library
concerned and a copy of the license accompanying it.

Nothing in this section restricts any of the rights you have under
the GNU General Public License.


SCOPE OF LICENSE
----------------

This license applies to this program (XaraLX) and its constituent source
files only, and does not necessarily apply to other Xara products which may
in part share the same code base, and are subject to their own licensing
terms.

This license does not apply to files in the wxXtra directory, which
are built into a separate library, and are subject to the wxWindows
license contained within that directory in the file "WXXTRA-LICENSE".

This license does not apply to the binary libraries (if any) within
the "libs" directory, which are subject to a separate license contained
within that directory in the file "LIBS-LICENSE".


ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS
----------------------------------------------

Subject to the terms of the GNU Public License (see above), you are
free to do whatever you like with your modifications. However, you may
(at your option) wish contribute them to Xara's source tree. You can
find details of how to do this at:
  http://www.xaraxtreme.org/developers/

Prior to contributing your modifications, you will need to complete our
contributor agreement. This can be found at:
  http://www.xaraxtreme.org/developers/contribute/

Please note that Xara will not accept modifications which modify any of
the text between the start and end of this header (marked
XARAHEADERSTART and XARAHEADEREND).


MARKS
-----

Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara
designs are registered or unregistered trademarks, design-marks, and/or
service marks of Xara Group Ltd. All rights in these marks are reserved.


      Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK.
                        http://www.xara.com/

=================================XARAHEADEREND============================
 */

// Bevel Attribute definitions

#ifndef INC_BEVELATTR
#define INC_BEVELATTR

//#include "nodeattr.h" - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "doccolor.h" - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "attr.h" - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "fillattr.h" - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "rndrgn.h" - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "becomea.h" - in camtypes.h [AUTOMATICALLY REMOVED]

class BevelAttributePathProcessor;

/********************************************************************************************

>   class BevelAttributeValueIndent : public AttributeValue

    Author:     David_McClarnon (Xara Group Ltd) <camelotdev@xara.com>
    Created:    18/11/98
    Purpose:    Sets the indent attribute
    SeeAlso:    

********************************************************************************************/

class BevelAttributeValueIndent : public AttributeValue
{
    CC_DECLARE_DYNCREATE(BevelAttributeValueIndent)
public:
    BevelAttributeValueIndent();
    BevelAttributeValueIndent(INT32 val) { m_Indent = val; }
    virtual void Restore(RenderRegion *, BOOL);
    virtual void Render(RenderRegion *, BOOL Temp = FALSE);
    virtual NodeAttribute *MakeNode();
    BOOL IsDifferent(AttributeValue *pAttr);
    virtual void SimpleCopy(AttributeValue *);
    
    static BOOL Init();

public:
    // the value
    INT32 m_Indent;

    
};

/********************************************************************************************

>   class AttrBevel : public NodeAttribute

    Author:     David_McClarnon (Xara Group Ltd) <camelotdev@xara.com>
    Created:    18/11/98
    Purpose:    Base class for bevel attributes
    SeeAlso:    
    Nodes:      Does nothing really but allow IsKindOf to pick up on bevel attributes

********************************************************************************************/
class AttrBevel : public NodeAttribute
{
CC_DECLARE_DYNCREATE(AttrBevel)
public:
    AttrBevel();
    AttrBevel(Node* ContextNode,  
                      AttachNodeDirection Direction,    
                      BOOL Locked=FALSE, 
                      BOOL Mangled=FALSE,  
                      BOOL Marked=FALSE, 
                      BOOL Selected=FALSE); 
} ;

/***********************************************************************************************

>   class AttrBevelIndent : public AttrBevel

    Author:     David_McClarnon (Xara Group Ltd) <camelotdev@xara.com>
    Created:    18/11/98
    Purpose:    Bevel indent attribute

***********************************************************************************************/

class AttrBevelIndent : public AttrBevel
{
    CC_DECLARE_DYNCREATE(AttrBevelIndent)

public:
    AttrBevelIndent(); 
    AttrBevelIndent(Node* ContextNode,  
                      AttachNodeDirection Direction,    
                      BOOL Locked=FALSE, 
                      BOOL Mangled=FALSE,  
                      BOOL Marked=FALSE, 
                      BOOL Selected=FALSE); 

    void Render( RenderRegion* pRender );
    virtual CCRuntimeClass* GetAttributeType() { return CC_RUNTIME_CLASS(AttrBevelIndent); }
    virtual AttributeValue* GetAttributeValue() { return &Value; }
    virtual AttrIndex GetAttributeIndex () { return ATTR_BEVELINDENT; }

    Node* SimpleCopy();                         // Copies a node
    virtual INT32 operator==(const NodeAttribute& NodeAttrib); 
    virtual UINT32 GetAttrNameID(void); 

    void ShowDebugTreeDetails() const;          // Debugging function

    void GetDebugDetails(StringBase* Str);

    virtual UINT32 GetNodeSize() const;             // Returns size of node in bytes

    virtual void Transform( TransformBase& );
    virtual BOOL EffectsParentBounds() { return TRUE; }

    // Version 2 file format functions
    virtual BOOL WritePreChildrenWeb(BaseCamelotFilter* pFilter);
    virtual BOOL WritePreChildrenNative(BaseCamelotFilter* pFilter);

    void SetValue(INT32 NewValue) { Value.m_Indent = NewValue; }

    BOOL Blend(BlendAttrParam* pBlendParam);
    virtual void PolyCopyNodeContents(NodeRenderable* pNodeCopy);

private:
    void CopyNodeContents( AttrBevelIndent* NodeCopy );

public:
    BevelAttributeValueIndent Value;
};

/********************************************************************************************

>   class BevelAttributeValueLightAngle : public AttributeValue

    Author:     David_McClarnon (Xara Group Ltd) <camelotdev@xara.com>
    Created:    18/11/98
    Purpose:    Sets the indent attribute
    SeeAlso:    

********************************************************************************************/

class BevelAttributeValueLightAngle : public AttributeValue
{
    CC_DECLARE_DYNCREATE(BevelAttributeValueLightAngle)
public:
    BevelAttributeValueLightAngle();
    BevelAttributeValueLightAngle(INT32 val) { m_LightAngle = val; }
    virtual void Restore(RenderRegion *, BOOL);
    virtual void Render(RenderRegion *, BOOL Temp = FALSE);
    virtual NodeAttribute *MakeNode();
    BOOL IsDifferent(AttributeValue *pAttr);
    virtual void SimpleCopy(AttributeValue *);

    static BOOL Init();

public:
    // the value
    INT32 m_LightAngle;
};

/***********************************************************************************************

>   class AttrBevelLightAngle : public AttrBevel

    Author:     David_McClarnon (Xara Group Ltd) <camelotdev@xara.com>
    Created:    18/11/98
    Purpose:    Bevel indent attribute

***********************************************************************************************/

class AttrBevelLightAngle : public AttrBevel
{
    CC_DECLARE_DYNCREATE(AttrBevelLightAngle)

public:
    AttrBevelLightAngle(); 
    AttrBevelLightAngle(Node* ContextNode,  
                      AttachNodeDirection Direction,    
                      BOOL Locked=FALSE, 
                      BOOL Mangled=FALSE,  
                      BOOL Marked=FALSE, 
                      BOOL Selected=FALSE); 

    virtual CCRuntimeClass* GetAttributeType() { return CC_RUNTIME_CLASS(AttrBevelLightAngle); }
    virtual AttributeValue* GetAttributeValue() { return &Value; }
    virtual AttrIndex GetAttributeIndex () { return ATTR_BEVELLIGHTANGLE; }

    void Render( RenderRegion* pRender );

    Node* SimpleCopy();                         // Copies a node
    virtual INT32 operator==(const NodeAttribute& NodeAttrib); 
    virtual UINT32 GetAttrNameID(void); 

    void ShowDebugTreeDetails() const;          // Debugging function

    void GetDebugDetails(StringBase* Str);

    virtual UINT32 GetNodeSize() const;             // Returns size of node in bytes

    virtual void Transform( TransformBase& );
    virtual BOOL EffectsParentBounds() { return FALSE; }

    // Version 2 file format functions
    virtual BOOL WritePreChildrenWeb(BaseCamelotFilter* pFilter);
    virtual BOOL WritePreChildrenNative(BaseCamelotFilter* pFilter);

    void SetValue(INT32 NewValue) { Value.m_LightAngle = NewValue; }

    BOOL Blend(BlendAttrParam* pBlendParam);
    virtual void PolyCopyNodeContents(NodeRenderable* pNodeCopy);

private:
    void CopyNodeContents( AttrBevelLightAngle* NodeCopy );

public:
    BevelAttributeValueLightAngle Value;
};

/********************************************************************************************

>   class BevelAttributeValueContrast : public AttributeValue

    Author:     David_McClarnon (Xara Group Ltd) <camelotdev@xara.com>
    Created:    18/11/98
    Purpose:    Sets the indent attribute
    SeeAlso:    

********************************************************************************************/

class BevelAttributeValueContrast : public AttributeValue
{
    CC_DECLARE_DYNCREATE(BevelAttributeValueContrast)
public:
    BevelAttributeValueContrast();
    BevelAttributeValueContrast(INT32 val) { m_Contrast = val; }
    virtual void Restore(RenderRegion *, BOOL);
    virtual void Render(RenderRegion *, BOOL Temp = FALSE);
    virtual NodeAttribute *MakeNode();
    BOOL IsDifferent(AttributeValue *pAttr);
    virtual void SimpleCopy(AttributeValue *);

    static BOOL Init();

public:
    // the value
    INT32 m_Contrast;
};

/***********************************************************************************************

>   class AttrBevelContrast : public AttrBevel

    Author:     David_McClarnon (Xara Group Ltd) <camelotdev@xara.com>
    Created:    18/11/98
    Purpose:    Bevel indent attribute

***********************************************************************************************/

class AttrBevelContrast : public AttrBevel
{
    CC_DECLARE_DYNCREATE(AttrBevelContrast)

public:
    AttrBevelContrast(); 
    AttrBevelContrast(Node* ContextNode,  
                      AttachNodeDirection Direction,    
                      BOOL Locked=FALSE, 
                      BOOL Mangled=FALSE,  
                      BOOL Marked=FALSE, 
                      BOOL Selected=FALSE); 

    virtual CCRuntimeClass* GetAttributeType() { return CC_RUNTIME_CLASS(AttrBevelContrast); }
    virtual AttributeValue* GetAttributeValue() { return &Value; }
    virtual AttrIndex GetAttributeIndex () { return ATTR_BEVELCONTRAST; }

    void Render( RenderRegion* pRender );

    Node* SimpleCopy();                         // Copies a node
    virtual INT32 operator==(const NodeAttribute& NodeAttrib); 
    virtual UINT32 GetAttrNameID(void); 

    void ShowDebugTreeDetails() const;          // Debugging function

    void GetDebugDetails(StringBase* Str);

    virtual UINT32 GetNodeSize() const;             // Returns size of node in bytes

    virtual void Transform( TransformBase& );
    virtual BOOL EffectsParentBounds() { return FALSE; }

    // Version 2 file format functions
    virtual BOOL WritePreChildrenWeb(BaseCamelotFilter* pFilter);
    virtual BOOL WritePreChildrenNative(BaseCamelotFilter* pFilter);

    void SetValue(INT32 NewValue) { Value.m_Contrast = NewValue; }

    BOOL Blend(BlendAttrParam* pBlendParam);
    virtual void PolyCopyNodeContents(NodeRenderable* pNodeCopy);

private:
    void CopyNodeContents( AttrBevelContrast* NodeCopy );

public:
    BevelAttributeValueContrast Value;
};

/********************************************************************************************

>   class BevelAttributeValueType : public AttributeValue

    Author:     David_McClarnon (Xara Group Ltd) <camelotdev@xara.com>
    Created:    18/11/98
    Purpose:    Sets the indent attribute
    SeeAlso:    

********************************************************************************************/

class BevelAttributeValueType : public AttributeValue
{
    CC_DECLARE_DYNCREATE(BevelAttributeValueType)
public:
    BevelAttributeValueType();
    ~BevelAttributeValueType();
    BevelAttributeValueType(INT32 val);
    virtual void Restore(RenderRegion *, BOOL);
    virtual void Render(RenderRegion *, BOOL Temp = FALSE);
    virtual NodeAttribute *MakeNode();
    virtual NodeAttribute *MakeNode(Node * pNode, AttachNodeDirection Direction);
    BOOL IsDifferent(AttributeValue *pAttr);
    virtual void SimpleCopy(AttributeValue *);
    INT32 operator=(AttributeValue& Attrib);
    INT32 operator==(AttributeValue& Attrib);

    // enables it to pop the path processor
    void GoingOutOfScope(RenderRegion * pRegion);

    static BOOL Init();

    void SetPassbackValue(BOOL b) { m_bPassback = b; }

public:
    // the value
    INT32 m_Type;

    // enables this node in the becomea/passback mechanism
    BOOL m_bPassback;

    // if we enable the passback mechanism, then we MUST hold copies
    // of the other attribute's values - this is because when GoingOutOfScope
    // is called on me, the other attributes could have already been replaced on the
    // stack
    void SetIndent(MILLIPOINT Indent) { m_Indent = Indent; }
    void SetLightAngle(double LightAngle) { m_LightAngle = LightAngle; }
    void SetContrast(INT32 Contrast)    { m_Contrast = Contrast; }

    MILLIPOINT GetIndent() { return m_Indent; }
    double GetLightAngle() { return m_LightAngle; }
    INT32 GetContrast()    { return m_Contrast; }

private:
    MILLIPOINT  m_Indent;
    double      m_LightAngle;
    INT32       m_Contrast;

private:
    BevelAttributePathProcessor * m_pProc;

    // creates the bevel bitmap out of the path processor, and the render region's
    // context stack
    KernelBitmap * CreateBevelBitmap(RenderRegion * pRegion);

    // renders the given bitmap
    BOOL RenderBitmap(RenderRegion * pRegion, KernelBitmap * pBitmap,
                        Path * pSrcPath, Path * pRenderPath);
};

/***********************************************************************************************

>   class AttrBevelType : public AttrBevel

    Author:     David_McClarnon (Xara Group Ltd) <camelotdev@xara.com>
    Created:    18/11/98
    Purpose:    Bevel indent attribute

***********************************************************************************************/

class AttrBevelType : public AttrBevel
{
    CC_DECLARE_DYNCREATE(AttrBevelType)

public:
    AttrBevelType(); 
    AttrBevelType(Node* ContextNode,  
                      AttachNodeDirection Direction,    
                      BOOL Locked=FALSE, 
                      BOOL Mangled=FALSE,  
                      BOOL Marked=FALSE, 
                      BOOL Selected=FALSE); 

    void Render( RenderRegion* pRender );

    Node* SimpleCopy();                         // Copies a node
    virtual INT32 operator==(const NodeAttribute& NodeAttrib); 
    virtual UINT32 GetAttrNameID(void); 

    virtual CCRuntimeClass* GetAttributeType() { return CC_RUNTIME_CLASS(AttrBevelType); }
    virtual AttributeValue* GetAttributeValue() { return &Value; }
    virtual AttrIndex GetAttributeIndex () { return ATTR_BEVELTYPE; }

    void ShowDebugTreeDetails() const;          // Debugging function

    void GetDebugDetails(StringBase* Str);

    virtual UINT32 GetNodeSize() const;             // Returns size of node in bytes

    virtual void Transform( TransformBase& );
    
    // Version 2 file format functions
    virtual BOOL WritePreChildrenWeb(BaseCamelotFilter* pFilter);
    virtual BOOL WritePreChildrenNative(BaseCamelotFilter* pFilter);

    void SetValue(INT32 NewValue) { Value.m_Type = NewValue; }

    // the blend function for this value
    virtual BOOL Blend(BlendAttrParam* pBlendParam);

    virtual BOOL EffectsParentBounds() { return Value.m_bPassback; }
    DocRect GetAttrBoundingRect(NodeRenderableInk* pParent = NULL, CCAttrMap* pAttribMap = NULL);

    virtual BOOL CanBecomeA(BecomeA* pBecomeA);
    virtual BOOL DoBecomeA(BecomeA* pBecomeA);
    virtual void PolyCopyNodeContents(NodeRenderable* pNodeCopy);

private:
    void CopyNodeContents( AttrBevelType* NodeCopy );

public:
    BevelAttributeValueType Value;
};

/********************************************************************************************

>   class BevelAttributeValueLightTilt : public AttributeValue

    Author:     David_McClarnon (Xara Group Ltd) <camelotdev@xara.com>
    Created:    18/11/98
    Purpose:    Sets the indent attribute
    SeeAlso:    

********************************************************************************************/

class BevelAttributeValueLightTilt : public AttributeValue
{
    CC_DECLARE_DYNCREATE(BevelAttributeValueLightTilt)
public:
    BevelAttributeValueLightTilt();
    BevelAttributeValueLightTilt(INT32 val) { m_LightTilt = val; }
    virtual void Restore(RenderRegion *, BOOL);
    virtual void Render(RenderRegion *, BOOL Temp = FALSE);
    virtual NodeAttribute *MakeNode();
    BOOL IsDifferent(AttributeValue *pAttr);
    virtual void SimpleCopy(AttributeValue *);

    static BOOL Init();

public:
    // the value
    INT32 m_LightTilt;
};

/***********************************************************************************************

>   class AttrBevelLightTilt : public AttrBevel

    Author:     David_McClarnon (Xara Group Ltd) <camelotdev@xara.com>
    Created:    18/11/98
    Purpose:    Bevel indent attribute

***********************************************************************************************/

class AttrBevelLightTilt : public AttrBevel
{
    CC_DECLARE_DYNCREATE(AttrBevelLightTilt)

public:
    AttrBevelLightTilt(); 
    AttrBevelLightTilt(Node* ContextNode,  
                      AttachNodeDirection Direction,    
                      BOOL Locked=FALSE, 
                      BOOL Mangled=FALSE,  
                      BOOL Marked=FALSE, 
                      BOOL Selected=FALSE); 

    virtual CCRuntimeClass* GetAttributeType() { return CC_RUNTIME_CLASS(AttrBevelLightTilt); }
    virtual AttributeValue* GetAttributeValue() { return &Value; }
    virtual AttrIndex GetAttributeIndex () { return ATTR_BEVELLIGHTTILT; }

    void Render( RenderRegion* pRender );

    Node* SimpleCopy();                         // Copies a node
    virtual INT32 operator==(const NodeAttribute& NodeAttrib); 
    virtual UINT32 GetAttrNameID(void); 

    void ShowDebugTreeDetails() const;          // Debugging function

    void GetDebugDetails(StringBase* Str);

    virtual UINT32 GetNodeSize() const;             // Returns size of node in bytes

    virtual void Transform( TransformBase& );
    virtual BOOL EffectsParentBounds() { return FALSE; }

    // Version 2 file format functions
    virtual BOOL WritePreChildrenWeb(BaseCamelotFilter* pFilter);
    virtual BOOL WritePreChildrenNative(BaseCamelotFilter* pFilter);

    void SetValue(INT32 NewValue) { Value.m_LightTilt = NewValue; }

    BOOL Blend(BlendAttrParam* pBlendParam);
    virtual void PolyCopyNodeContents(NodeRenderable* pNodeCopy);

private:
    void CopyNodeContents( AttrBevelLightTilt* NodeCopy );

public:
    BevelAttributeValueLightTilt Value;
};

#endif

---