attrbev.cpp

Go to the documentation of this file.

// $Id: attrbev.cpp 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============================
 */

/*
*/
    
#include "camtypes.h"                          
#include "attrbev.h"
//#include "errors.h" - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "mario.h"
//#include "simon.h"
//#include "tim.h"
//#include "will.h"
//#include "attrmgr.h" - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "tranform.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "blobs.h"
//#include "app.h" - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "fixed16.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "blendatt.h"
#include "nodepath.h"
//#include "ink.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "attrmap.h"
//#include "camfiltr.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "cxftags.h"
//#include "cxfdefs.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "rechattr.h"   // Record handling classes for attributes
//#include "cxfrec.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "cxfdash.h"    // Default dash pattern references
#include "cxfarrow.h"   // Default arrow head/tail references
#include "cxfcols.h"    // REF_DEFAULTCOLOUR_TRANSPARENT ...
//#include "bevres.h"
#include "ppbevel.h"
#include "cxftags.h"
//#include "cxfdefs.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "nbevcont.h"
//#include "view.h" - in camtypes.h [AUTOMATICALLY REMOVED]
//#include "docview.h" - in camtypes.h [AUTOMATICALLY REMOVED]
#include "beveler.h"
//#include "biasgain.h" - in camtypes.h [AUTOMATICALLY REMOVED]

DECLARE_SOURCE("$Revision: 1282 $");

CC_IMPLEMENT_DYNCREATE(AttrBevel,   NodeAttribute)
CC_IMPLEMENT_DYNCREATE(AttrBevelIndent, AttrBevel)
CC_IMPLEMENT_DYNCREATE(BevelAttributeValueIndent,   AttributeValue)
CC_IMPLEMENT_DYNCREATE(AttrBevelLightAngle, AttrBevel)
CC_IMPLEMENT_DYNCREATE(BevelAttributeValueLightAngle,   AttributeValue)
CC_IMPLEMENT_DYNCREATE(AttrBevelContrast,   AttrBevel)
CC_IMPLEMENT_DYNCREATE(BevelAttributeValueContrast, AttributeValue)
CC_IMPLEMENT_DYNCREATE(AttrBevelType,   AttrBevel)
CC_IMPLEMENT_DYNCREATE(BevelAttributeValueType, AttributeValue)
CC_IMPLEMENT_DYNCREATE(AttrBevelLightTilt,  AttrBevel)
CC_IMPLEMENT_DYNCREATE(BevelAttributeValueLightTilt,    AttributeValue)



// Declare smart memory handling in Debug builds
#define new CAM_DEBUG_NEW

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

>   AttrBevel::AttrBevelIndent(Node* ContextNode,  
                    AttachNodeDirection Direction,  
                    BOOL Locked, 
                    BOOL Mangled,  
                    BOOL Marked, 
                    BOOL Selected    
            ): NodeAttribute(ContextNode, Direction, Locked, Mangled, Marked, Selected, TRUE)  

    Author:     David_McClarnon (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/11/99
    Inputs:     -
    Outputs:    -
    Returns:    -
    Purpose:    Bevel attribute constructor
    Errors:     -
    SeeAlso:    -

********************************************************************************************/
AttrBevel::AttrBevel(Node* ContextNode,  
                    AttachNodeDirection Direction,  
                    BOOL Locked, 
                    BOOL Mangled,  
                    BOOL Marked, 
                    BOOL Selected    
            ): NodeAttribute(ContextNode, Direction, Locked, Mangled, Marked, Selected)  
{
    
}

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

>   AttrBevel::AttrBevel()

    Author:     David_McClarnon (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/11/99
    Inputs:     -
    Outputs:    -
    Returns:    -
    Purpose:    Bevel attribute constructor
    Errors:     -
    SeeAlso:    -

********************************************************************************************/
AttrBevel::AttrBevel()
{
}

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

>   AttrBevelIndent::AttrBevelIndent(Node* ContextNode,  
                    AttachNodeDirection Direction,  
                    BOOL Locked, 
                    BOOL Mangled,  
                    BOOL Marked, 
                    BOOL Selected    
            ): NodeAttribute(ContextNode, Direction, Locked, Mangled, Marked, Selected, TRUE)  

    Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/6/93
    Inputs:     -
    Outputs:    -
    Returns:    -
    Purpose:    Creates a bValue Attribute
    Errors:     -
    SeeAlso:    -

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

AttrBevelIndent::AttrBevelIndent(Node* ContextNode,  
                    AttachNodeDirection Direction,  
                    BOOL Locked, 
                    BOOL Mangled,  
                    BOOL Marked, 
                    BOOL Selected    
            ): AttrBevel(ContextNode, Direction, Locked, Mangled, Marked, Selected)  
{                         
} 

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

>   AttrBevelIndent::AttrBevelIndent()

    Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/6/93
    Inputs:     -
    Outputs:    -
    Returns:    -
    Purpose:    Default constructor for Line Width Attribute class
    Errors:     -
    SeeAlso:    -

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

AttrBevelIndent::AttrBevelIndent()
{
}

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

>   void AttrBevelIndent::Render( RenderRegion* pRender)

    Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/6/93
    Inputs:     -
    Outputs:    -
    Returns:    -
    Purpose:    'Renders' a Line Width attribute.
    Errors:     -
    SeeAlso:    -

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

void AttrBevelIndent::Render( RenderRegion* pRender)
{
}

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

>   void AttrBevelIndent::Transform( TransformBase& Trans )

    Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
    Created:    1/8/94
    Inputs:     Trans - the transform object to apply to this attribute.
    Purpose:    Scale the Line Width.
    SeeAlso:    NodeRenderable::Transform

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

void AttrBevelIndent::Transform( TransformBase& Trans )
{
    INT32 OldIndent = Value.m_Indent;
    
    // Find out the equivalent scale factor
    FIXED16 ScaleFactor = Trans.GetScalar();

    // no scaling then lets leave
    if (ScaleFactor.MakeDouble() == 1.0)
        return;

    // And scale the line width
    Value.m_Indent= labs( INT32(ScaleFactor.MakeDouble() * ((double)Value.m_Indent)) );

    // MRH - 3/7/00 - Added a quick check to see if the indent is greater than the slider limit.
    // If so then reset the value to the limit! ERROR3 For Debugging - can be taken out if anouying!
    if (Value.m_Indent > 250000)
    {
        ERROR3("Bevel Indent > Max Value! Setting to Max Value!");
        Value.m_Indent = 250000;
    }

    if (OldIndent < 0)
    {
        Value.m_Indent = -Value.m_Indent;
    }
}

/***********************************************************************************************
> Node* AttrBevelIndent::SimpleCopy() 

    Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/6/93
    
    Inputs:         - 
    Outputs:     
    Returns:    A copy of the node, or NULL if memory runs out 
         
    Purpose:    This method returns a shallow copy of the node with all Node pointers NULL. 
                The function is virtual, and must be defined for all derived classes.  

    Errors:     If memory runs out when trying to copy, then ERROR is called with an out of memory
                error and the function returns NULL. 
    
    Scope:      protected       
***********************************************************************************************/
     
Node* AttrBevelIndent::SimpleCopy()
{
    AttrBevelIndent* NodeCopy = new AttrBevelIndent();
    ERRORIF(NodeCopy == NULL, _R(IDE_NOMORE_MEMORY), NULL); 
    CopyNodeContents(NodeCopy);
    NodeCopy->Value.m_Indent = Value.m_Indent;
    return NodeCopy;
} 

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

>   INT32 AttrBevelIndent::operator==(const NodeAttribute& Attrib)

    Author:     Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
    Created:    9/2/94
    Inputs:     Atrib:  The attribute to compare, which must be an AttrBevelIndent 
    Outputs:    -
    Returns:    -
    Purpose:    A virtual comparison operator. See NodeAttribute::operator== for 
                a description of why it's required. 
 
    Errors:     An ENSURE failure will occur if Attrib does not have a AttrBevelIndent 
                runtime class.
                 
    SeeAlso:    NodeAttribute::operator==

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

INT32 AttrBevelIndent::operator==(const NodeAttribute& Attrib)
{
    ENSURE(Attrib.IsKindOf(CC_RUNTIME_CLASS(AttrBevelIndent)), 
        "Trying to compare two objects with different types"); 
    AttrBevelIndent * Attr = (AttrBevelIndent *) &Attrib;
    return (Attr->Value.m_Indent == Value.m_Indent); 
} 


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

>   virtual UINT32 AttrBevelIndent::GetAttrNameID(void)  

    Author:     Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
    Created:    22/2/94
    Inputs:     -
    Outputs:    -
    Returns:    Attribute description ID
    Purpose:    Returns back a string resource ID describing the attribute

    Errors:     -
    SeeAlso:    -

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

UINT32 AttrBevelIndent::GetAttrNameID(void)  
{
    return (_R(IDS_BEVEL_INDENT_ID)); 
}               
                 

/***********************************************************************************************
> ` void AttrBevel::CopyNodeContents( AttrBevelIndent* NodeCopy)

    Author:     Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
    Created:    28/4/93
    
    Inputs:           
    Outputs:    A copy of this node
    Returns:    -
         
    Purpose:    This method copies the node's contents to the node pointed to by NodeCopy.
              
    Errors:     An assertion failure will occur if NodeCopy is NULL
    
    Scope:      protected
                                     
***********************************************************************************************/

void AttrBevelIndent::CopyNodeContents( AttrBevelIndent* NodeCopy)
{
    NodeAttribute::CopyNodeContents( NodeCopy );

    NodeCopy->Value = Value;
} 

/***********************************************************************************************
>   void NodeRenderableBounded::PolyCopyNodeContents(NodeRenderable* pNodeCopy)

    Author:     Phil_Martin (Xara Group Ltd) <camelotdev@xara.com>
    Created:    18/12/2003
    Outputs:    -
    Purpose:    Polymorphically copies the contents of this node to another
    Errors:     An assertion failure will occur if NodeCopy is NULL
    Scope:      protected
                                     
***********************************************************************************************/

void AttrBevelIndent::PolyCopyNodeContents(NodeRenderable* pNodeCopy)
{
    ENSURE(pNodeCopy, "Trying to copy a node's contents into a NULL node");
    ENSURE(IS_A(pNodeCopy, AttrBevelIndent), "PolyCopyNodeContents given wrong dest node type");

    if (IS_A(pNodeCopy, AttrBevelIndent))
        CopyNodeContents((AttrBevelIndent*)pNodeCopy);
}



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

>   void AttrBevelIndent::ShowDebugTreeDetails() const

    Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/6/93
    Purpose:    Displays debugging info of the tree

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

void AttrBevelIndent::ShowDebugTreeDetails() const
{
    // Display a bit of debugging info
    // For now, we will just call the base class version
#ifdef _DEBUG
    NodeAttribute::ShowDebugTreeDetails();  
#endif
}


void AttrBevelIndent::GetDebugDetails(StringBase* Str)
{
#ifdef _DEBUG
    NodeAttribute::GetDebugDetails( Str );

    String_256 TempStr;
    TempStr._MakeMsg( TEXT("\r\nValue=#1%d\r\n"), Value.m_Indent );
    (*Str) += TempStr;
#else
    if (Str)
    {
        *Str = wxT("");
    }
#endif
}



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

>   virtual UINT32 AttrBevelIndent::GetNodeSize() const

    Author:     Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
    Created:    6/10/93
    Inputs:     -
    Outputs:    -
    Returns:    The size of the node in bytes
    Purpose:    For finding the size of the node 
                
    SeeAlso:    Node::GetSubtreeSize

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

UINT32 AttrBevelIndent::GetNodeSize() const 
{     
    return (sizeof(AttrBevelIndent)); 
}  

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

>   BOOL AttrBevelIndent::Blend(BlendAttrParam* pBlendParam)

    Author:     David_McClarnon (Xara Group Ltd) <camelotdev@xara.com>
    Created:    12/12/99
    Inputs:     The blend attribute param
    Purpose:    Blends this indent to another
    SeeAlso:    

********************************************************************************************/
BOOL AttrBevelIndent::Blend(BlendAttrParam* pBlendParam)
{
    AttrBevelIndent * pBlendedAttr = NULL;

    // assign the other attribute we're looking at
    AttrBevelIndent * pOtherAttr = (AttrBevelIndent *)pBlendParam->GetOtherAttr();

    // split at the half way mark
    if (pBlendParam->GetBlendRatio() <= 0.5)
    {
        pBlendedAttr = (AttrBevelIndent *)SimpleCopy();
    }
    else
    {
        pBlendedAttr = (AttrBevelIndent *)pOtherAttr->SimpleCopy();
    }

    // set the blended attribute
    pBlendParam->SetBlendedAttr(pBlendedAttr);

    if (!pBlendedAttr)
        return FALSE;

    double Indent1          = Value.m_Indent;
    double Indent2          = pOtherAttr->Value.m_Indent;
    double NewIndent        = ((Indent2 - Indent1) * pBlendParam->GetBlendRatio()) + Indent1;

    // set the blended attribute's values
    pBlendedAttr->Value.m_Indent = (MILLIPOINT)NewIndent;
    
    return TRUE;
}



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

  > virtual BOOL AttrBevelIndent::WritePreChildrenWeb(BaseCamelotFilter* pFilter)

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    30/5/96
    Inputs:     pFilter = ptr to the filter
    Returns:    TRUE if record is written, FALSE if not
    Purpose:    Writes the line width record to the filter
    SeeAlso:    -

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

BOOL AttrBevelIndent::WritePreChildrenWeb(BaseCamelotFilter* pFilter)
{
    return TRUE;
}

//--------------------------------------------------------------
// See AttrBevelIndent::WritePreChildrenWeb(BaseCamelotFilter* pFilter)
//
BOOL AttrBevelIndent::WritePreChildrenNative(BaseCamelotFilter* pFilter)
{
#ifdef DO_EXPORT
    return WritePreChildrenWeb(pFilter);
#else
    return FALSE;
#endif
}

// the actual attribute

BevelAttributeValueIndent::BevelAttributeValueIndent()
{
//  m_Indent = -3000;
    m_Indent = 0;
}

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

>   void BevelAttributeValueIndent::Render(RenderRegion *pRegion)

    Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
    Created:    03/02/94
    Inputs:     pRegion - the render region to render this attribute into.
    Purpose:    Sets the line width attribute for the given render region. i.e. all
                lines drawn will now be drawn with this line width.
    SeeAlso:    BevelAttributeValueIndent; RenderStack; AttributeValue; NodeAttribute;
                BevelAttributeValueIndent::Restore; BevelAttributeValueIndent::SimpleCopy;
                AttributeValue::Render; AttributeValue::Restore; AttributeValue::SimpleCopy

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

void BevelAttributeValueIndent::Render(RenderRegion *pRegion, BOOL Temp)
{
}

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

>   void BevelAttributeValueIndent::Restore(RenderRegion *pRegion, BOOL Temp)

    Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
    Created:    03/02/94
    Inputs:     pRegion - the render region to restore the attribute into.
                Temp    - TRUE if this is a temporary attribute, FALSE if it is
                          permanent (e.g. it's in a document tree).
    Purpose:    Restores the line width attribute for the given render region. i.e. all
                lines drawn will now be drawn with this line width.
    SeeAlso:    BevelAttributeValueIndent; RenderStack; AttributeValue; NodeAttribute;
                BevelAttributeValueIndent::Render; BevelAttributeValueIndent::SimpleCopy;
                AttributeValue::Render; AttributeValue::Restore; AttributeValue::SimpleCopy

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

void BevelAttributeValueIndent::Restore(RenderRegion *pRegion, BOOL Temp)
{
}

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

>   void BevelAttributeValueIndent::SimpleCopy(AttributeValue *pValue)

    Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
    Created:    03/02/94
    Inputs:     pAttr - pointer to the AttributeValue to copy.
    Purpose:    See AttributeValue::SimpleCopy
    SeeAlso:    BevelAttributeValueIndent; RenderStack; AttributeValue; NodeAttribute;
                BevelAttributeValueIndent::Render; BevelAttributeValueIndent::Restore;
                AttributeValue::Render; AttributeValue::Restore; AttributeValue::SimpleCopy

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

void BevelAttributeValueIndent::SimpleCopy(AttributeValue *pValue)
{
    m_Indent = ((BevelAttributeValueIndent *) pValue)->m_Indent;
}

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

>   BOOL BevelAttributeValueIndent::Init()

    Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
    Created:    11/04/94
    Returns:    TRUE - initialised ok; FALSE if not.
    Purpose:    Registers line width attribute, and provides a default attribute to give
                0.25pt lines.
    Errors:     Out of memory.
    SeeAlso:    AttributeManager

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

BOOL BevelAttributeValueIndent::Init()
{
    BevelAttributeValueIndent *pAttr = new BevelAttributeValueIndent;
    if (pAttr == NULL)
        return FALSE;

    UINT32 ID = AttributeManager::RegisterDefaultAttribute(CC_RUNTIME_CLASS(NodeRenderableInk), 
                                                         pAttr);
    if (ID == ATTR_BAD_ID)
        return FALSE;
    ENSURE(ID == ATTR_BEVELINDENT, "Incorrect ID for attribute!");
    return TRUE;
}

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

>   NodeAttribute *BevelAttributeValueIndent::MakeNode()

    Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
    Created:    11/04/94
    Returns:    Pointer to the new node, or NULL if out of memory.
    Purpose:    Make a AttrbValue node from this line width attribute.
    Errors:     Out of memory
    SeeAlso:    AttributeValue::MakeNode

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

NodeAttribute *BevelAttributeValueIndent::MakeNode()
{
    // Create new attribute node
    AttrBevelIndent *pAttr = new AttrBevelIndent();

    // Copy attribute value into the new node.
    pAttr->Value.SimpleCopy(this);

    // Return the new node
    return pAttr;
}

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

>   BOOL BevelAttributeValueIndent::IsDifferent(AttributeValue *pAttr)

    Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
    Created:    12/04/94
    Purpose:    See base class version.
    Errors:     The two attributes are not of the same type.
    SeeAlso:    AttributeValue::IsDifferent

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

BOOL BevelAttributeValueIndent::IsDifferent(AttributeValue *pAttr)
{
    ENSURE(GetRuntimeClass() == pAttr->GetRuntimeClass(), 
           "Different attribute types in AttributeValue::IsDifferent()");
    return ((BevelAttributeValueIndent *) pAttr)->m_Indent != m_Indent;
}

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

>   AttrBevelContrast::AttrBevelContrast(Node* ContextNode,  
                    AttachNodeDirection Direction,  
                    BOOL Locked, 
                    BOOL Mangled,  
                    BOOL Marked, 
                    BOOL Selected    
            ): NodeAttribute(ContextNode, Direction, Locked, Mangled, Marked, Selected, TRUE)  

    Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/6/93
    Inputs:     -
    Outputs:    -
    Returns:    -
    Purpose:    Creates a bValue Attribute
    Errors:     -
    SeeAlso:    -

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

AttrBevelContrast::AttrBevelContrast(Node* ContextNode,  
                    AttachNodeDirection Direction,  
                    BOOL Locked, 
                    BOOL Mangled,  
                    BOOL Marked, 
                    BOOL Selected    
            ): AttrBevel(ContextNode, Direction, Locked, Mangled, Marked, Selected)  
{                         
} 

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

>   AttrBevelContrast::AttrBevelContrast()

    Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/6/93
    Inputs:     -
    Outputs:    -
    Returns:    -
    Purpose:    Default constructor for Line Width Attribute class
    Errors:     -
    SeeAlso:    -

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

AttrBevelContrast::AttrBevelContrast()
{
}


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

>   void AttrBevelContrast::Render( RenderRegion* pRender)

    Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/6/93
    Inputs:     -
    Outputs:    -
    Returns:    -
    Purpose:    'Renders' a Line Width attribute.
    Errors:     -
    SeeAlso:    -

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

void AttrBevelContrast::Render( RenderRegion* pRender)
{
}

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

>   void AttrBevelContrast::Transform( TransformBase& Trans )

    Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
    Created:    1/8/94
    Inputs:     Trans - the transform object to apply to this attribute.
    Purpose:    Scale the Line Width.
    SeeAlso:    NodeRenderable::Transform

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

void AttrBevelContrast::Transform( TransformBase& Trans )
{
    
}

/***********************************************************************************************
> Node* AttrBevelContrast::SimpleCopy() 

    Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/6/93
    
    Inputs:         - 
    Outputs:     
    Returns:    A copy of the node, or NULL if memory runs out 
         
    Purpose:    This method returns a shallow copy of the node with all Node pointers NULL. 
                The function is virtual, and must be defined for all derived classes.  

    Errors:     If memory runs out when trying to copy, then ERROR is called with an out of memory
                error and the function returns NULL. 
    
    Scope:      protected       
***********************************************************************************************/
     
Node* AttrBevelContrast::SimpleCopy()
{
    AttrBevelContrast* NodeCopy = new AttrBevelContrast();
    ERRORIF(NodeCopy == NULL, _R(IDE_NOMORE_MEMORY), NULL); 
    CopyNodeContents(NodeCopy);
    NodeCopy->Value.m_Contrast = Value.m_Contrast;
    return NodeCopy;
} 

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

>   INT32 AttrBevelContrast::operator==(const NodeAttribute& Attrib)

    Author:     Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
    Created:    9/2/94
    Inputs:     Atrib:  The attribute to compare, which must be an AttrBevelContrast 
    Outputs:    -
    Returns:    -
    Purpose:    A virtual comparison operator. See NodeAttribute::operator== for 
                a description of why it's required. 
 
    Errors:     An ENSURE failure will occur if Attrib does not have a AttrBevelContrast 
                runtime class.
                 
    SeeAlso:    NodeAttribute::operator==

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

INT32 AttrBevelContrast::operator==(const NodeAttribute& Attrib)
{
    ENSURE(Attrib.IsKindOf(CC_RUNTIME_CLASS(AttrBevelContrast)), 
        "Trying to compare two objects with different types"); 
    AttrBevelContrast * Attr = (AttrBevelContrast *) &Attrib;
    return (Attr->Value.m_Contrast == Value.m_Contrast); 
} 


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

>   virtual UINT32 AttrBevelContrast::GetAttrNameID(void)  

    Author:     Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
    Created:    22/2/94
    Inputs:     -
    Outputs:    -
    Returns:    Attribute description ID
    Purpose:    Returns back a string resource ID describing the attribute

    Errors:     -
    SeeAlso:    -

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

UINT32 AttrBevelContrast::GetAttrNameID(void)  
{
    return (_R(IDS_BEVEL_CONTRAST_ID)); 
}               
                 

/***********************************************************************************************
> ` void AttrBevel::CopyNodeContents( AttrBevelContrast* NodeCopy)

    Author:     Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
    Created:    28/4/93
    
    Inputs:           
    Outputs:    A copy of this node
    Returns:    -
         
    Purpose:    This method copies the node's contents to the node pointed to by NodeCopy.
              
    Errors:     An assertion failure will occur if NodeCopy is NULL
    
    Scope:      protected
                                     
***********************************************************************************************/

void AttrBevelContrast::CopyNodeContents( AttrBevelContrast* NodeCopy)
{
    NodeAttribute::CopyNodeContents( NodeCopy );

    NodeCopy->Value = Value;
} 

/***********************************************************************************************
>   void AttrBevelContrast::PolyCopyNodeContents(NodeRenderable* pNodeCopy)

    Author:     Phil_Martin (Xara Group Ltd) <camelotdev@xara.com>
    Created:    18/12/2003
    Outputs:    -
    Purpose:    Polymorphically copies the contents of this node to another
    Errors:     An assertion failure will occur if NodeCopy is NULL
    Scope:      protected
                                     
***********************************************************************************************/

void AttrBevelContrast::PolyCopyNodeContents(NodeRenderable* pNodeCopy)
{
    ENSURE(pNodeCopy, "Trying to copy a node's contents into a NULL node");
    ENSURE(IS_A(pNodeCopy, AttrBevelContrast), "PolyCopyNodeContents given wrong dest node type");

    if (IS_A(pNodeCopy, AttrBevelContrast))
        CopyNodeContents((AttrBevelContrast*)pNodeCopy);
}



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

>   BOOL AttrBevelContrast::Blend(BlendAttrParam* pBlendParam)

    Author:     David_McClarnon (Xara Group Ltd) <camelotdev@xara.com>
    Created:    12/12/99
    Inputs:     The blend attribute param
    Purpose:    Blends this light angle to another
    SeeAlso:    

********************************************************************************************/
BOOL AttrBevelContrast::Blend(BlendAttrParam* pBlendParam)
{
    ERROR2IF(pBlendParam == NULL,FALSE,"pBlendParam == NULL");
    ERROR3IF(!(pBlendParam->GetOtherAttr()->IS_KIND_OF(AttrBevelContrast)),
        "Blend attribute isn't a bevel contrast attribute");

    AttrBevelContrast * pBlendedAttr = NULL;

    // assign the other attribute we're looking at
    AttrBevelContrast * pOtherAttr = (AttrBevelContrast *)pBlendParam->GetOtherAttr();

    // split at the half way mark
    if (pBlendParam->GetBlendRatio() <= 0.5)
    {
        pBlendedAttr = (AttrBevelContrast *)SimpleCopy();
    }
    else
    {
        pBlendedAttr = (AttrBevelContrast *)pOtherAttr->SimpleCopy();
    }

    // set the blended attribute
    pBlendParam->SetBlendedAttr(pBlendedAttr);
    
    if (!pBlendedAttr)
        return FALSE;

    double Contrast1        = Value.m_Contrast;
    double Contrast2        = pOtherAttr->Value.m_Contrast;
    double NewContrast      = ((Contrast2 - Contrast1) * pBlendParam->GetBlendRatio()) +
                                Contrast1;

    // set the blended attribute's values
    pBlendedAttr->Value.m_Contrast = (INT32)NewContrast;

    return TRUE;
}


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

>   void AttrBevelContrast::ShowDebugTreeDetails() const

    Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/6/93
    Purpose:    Displays debugging info of the tree

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

void AttrBevelContrast::ShowDebugTreeDetails() const
{
    // Display a bit of debugging info
    // For now, we will just call the base class version
#ifdef _DEBUG
    NodeAttribute::ShowDebugTreeDetails();  
#endif
}


void AttrBevelContrast::GetDebugDetails(StringBase* Str)
{
#ifdef _DEBUG
    NodeAttribute::GetDebugDetails( Str );

    String_256 TempStr;
    TempStr._MakeMsg( TEXT("\r\nValue=#1%d\r\n"), Value.m_Contrast );
    (*Str)+= TempStr;
#else
    if (Str)
    {
        *Str = wxT("");
    }
#endif
}


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

>   virtual UINT32 AttrBevelContrast::GetNodeSize() const

    Author:     Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
    Created:    6/10/93
    Inputs:     -
    Outputs:    -
    Returns:    The size of the node in bytes
    Purpose:    For finding the size of the node 
                
    SeeAlso:    Node::GetSubtreeSize

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

UINT32 AttrBevelContrast::GetNodeSize() const 
{     
    return (sizeof(AttrBevelContrast)); 
}  

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

  > virtual BOOL AttrBevelContrast::WritePreChildrenWeb(BaseCamelotFilter* pFilter)

    Author:     Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
    Created:    30/5/96
    Inputs:     pFilter = ptr to the filter
    Returns:    TRUE if record is written, FALSE if not
    Purpose:    Writes the line width record to the filter
    SeeAlso:    -

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

BOOL AttrBevelContrast::WritePreChildrenWeb(BaseCamelotFilter* pFilter)
{
    return TRUE;
}

//--------------------------------------------------------------
// See AttrBevelContrast::WritePreChildrenWeb(BaseCamelotFilter* pFilter)
//
BOOL AttrBevelContrast::WritePreChildrenNative(BaseCamelotFilter* pFilter)
{
#ifdef DO_EXPORT
    return WritePreChildrenWeb(pFilter);
#else
    return FALSE;
#endif
}

// the actual attribute

BevelAttributeValueContrast::BevelAttributeValueContrast()
{
    m_Contrast = 50;
}

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

>   void BevelAttributeValueContrast::Render(RenderRegion *pRegion)

    Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
    Created:    03/02/94
    Inputs:     pRegion - the render region to render this attribute into.
    Purpose:    Sets the line width attribute for the given render region. i.e. all
                lines drawn will now be drawn with this line width.
    SeeAlso:    BevelAttributeValueContrast; RenderStack; AttributeValue; NodeAttribute;
                BevelAttributeValueContrast::Restore; BevelAttributeValueContrast::SimpleCopy;
                AttributeValue::Render; AttributeValue::Restore; AttributeValue::SimpleCopy

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

void BevelAttributeValueContrast::Render(RenderRegion *pRegion, BOOL Temp)
{
}

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

>   void BevelAttributeValueContrast::Restore(RenderRegion *pRegion, BOOL Temp)

    Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
    Created:    03/02/94
    Inputs:     pRegion - the render region to restore the attribute into.
                Temp    - TRUE if this is a temporary attribute, FALSE if it is
                          permanent (e.g. it's in a document tree).
    Purpose:    Restores the line width attribute for the given render region. i.e. all
                lines drawn will now be drawn with this line width.
    SeeAlso:    BevelAttributeValueContrast; RenderStack; AttributeValue; NodeAttribute;
                BevelAttributeValueContrast::Render; BevelAttributeValueContrast::SimpleCopy;
                AttributeValue::Render; AttributeValue::Restore; AttributeValue::SimpleCopy

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

void BevelAttributeValueContrast::Restore(RenderRegion *pRegion, BOOL Temp)
{
}

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

>   void BevelAttributeValueContrast::SimpleCopy(AttributeValue *pValue)

    Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
    Created:    03/02/94
    Inputs:     pAttr - pointer to the AttributeValue to copy.
    Purpose:    See AttributeValue::SimpleCopy
    SeeAlso:    BevelAttributeValueContrast; RenderStack; AttributeValue; NodeAttribute;
                BevelAttributeValueContrast::Render; BevelAttributeValueContrast::Restore;
                AttributeValue::Render; AttributeValue::Restore; AttributeValue::SimpleCopy

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

void BevelAttributeValueContrast::SimpleCopy(AttributeValue *pValue)
{
    m_Contrast = ((BevelAttributeValueContrast *) pValue)->m_Contrast;
}

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

>   BOOL BevelAttributeValueContrast::Init()

    Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
    Created:    11/04/94
    Returns:    TRUE - initialised ok; FALSE if not.
    Purpose:    Registers line width attribute, and provides a default attribute to give
                0.25pt lines.
    Errors:     Out of memory.
    SeeAlso:    AttributeManager

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

BOOL BevelAttributeValueContrast::Init()
{
    BevelAttributeValueContrast *pAttr = new BevelAttributeValueContrast;
    if (pAttr == NULL)
        return FALSE;

    UINT32 ID = AttributeManager::RegisterDefaultAttribute(CC_RUNTIME_CLASS(NodeRenderableInk), 
                                                         pAttr);
    if (ID == ATTR_BAD_ID)
        return FALSE;
    ENSURE(ID == ATTR_BEVELCONTRAST, "Incorrect ID for attribute!");
    return TRUE;
}

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

>   NodeAttribute *BevelAttributeValueContrast::MakeNode()

    Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
    Created:    11/04/94
    Returns:    Pointer to the new node, or NULL if out of memory.
    Purpose:    Make a AttrbValue node from this line width attribute.
    Errors:     Out of memory
    SeeAlso:    AttributeValue::MakeNode

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

NodeAttribute *BevelAttributeValueContrast::MakeNode()
{
    // Create new attribute node
    AttrBevelContrast *pAttr = new AttrBevelContrast();

    // Copy attribute value into the new node.
    pAttr->Value.SimpleCopy(this);

    // Return the new node
    return pAttr;
}

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

>   BOOL BevelAttributeValueContrast::IsDifferent(AttributeValue *pAttr)

    Author:     Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
    Created:    12/04/94
    Purpose:    See base class version.
    Errors:     The two attributes are not of the same type.
    SeeAlso:    AttributeValue::IsDifferent

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

BOOL BevelAttributeValueContrast::IsDifferent(AttributeValue *pAttr)
{
    ENSURE(GetRuntimeClass() == pAttr->GetRuntimeClass(), 
           "Different attribute types in AttributeValue::IsDifferent()");
    return ((BevelAttributeValueContrast *) pAttr)->m_Contrast != m_Contrast;
}

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

>   AttrBevelType::AttrBevelType(Node* ContextNode,  
                    AttachNodeDirection Direction,  
                    BOOL Locked, 
                    BOOL Mangled,  
                    BOOL Marked, 
                    BOOL Selected    
            ): NodeAttribute(ContextNode, Direction, Locked, Mangled, Marked, Selected, TRUE)  

    Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/6/93
    Inputs:     -
    Outputs:    -
    Returns:    -
    Purpose:    Creates a bValue Attribute
    Errors:     -
    SeeAlso:    -

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

AttrBevelType::AttrBevelType(Node* ContextNode,  
                    AttachNodeDirection Direction,  
                    BOOL Locked, 
                    BOOL Mangled,  
                    BOOL Marked, 
                    BOOL Selected    
            ): AttrBevel(ContextNode, Direction, Locked, Mangled, Marked, Selected)  
{                         
} 

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

>   AttrBevelType::AttrBevelType()

    Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
    Created:    21/6/93
    Inputs:     -
    Outputs:    -
    Returns:    -
    Purpose:    Default constructor for Line Width Attribute class
    Errors:     -
    SeeAlso:    -

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

AttrBevelType::AttrBevelType()
{
}

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

>   void AttrBevelType::Render( RenderRegion* pRender)

    Author:     Wil