Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Search for 

AttrFillEffectFade Class Reference

RGB Fade fill effect Attribute class. More...

#include <fillattr2.h>

Inheritance diagram for AttrFillEffectFade:

AttrFillEffect NodeAttribute NodeRenderable Node CCObject SimpleCCObject List of all members.

Public Member Functions

 AttrFillEffectFade ()
 AttrFillEffectFade (Node *ContextNode, AttachNodeDirection Direction, BOOL Locked=FALSE, BOOL Mangled=FALSE, BOOL Marked=FALSE, BOOL Selected=FALSE)
void Render (RenderRegion *pRender)
 'Renders' a RGB fade fill effect attribute.
Node * SimpleCopy ()
 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.
virtual UINT32 GetAttrNameID (void)
 Returns a string resource ID describing the attribute.
virtual UINT32 GetNodeSize () const
 For finding the size of the node.
virtual AttributeValue * GetAttributeValue ()
virtual BOOL WritePreChildrenWeb (BaseCamelotFilter *pFilter)
 Writes the fade fill effect record to the filter.
virtual BOOL WritePreChildrenNative (BaseCamelotFilter *pFilter)
virtual void PolyCopyNodeContents (NodeRenderable *pNodeCopy)
 Polymorphically copies the contents of this node to another.

Public Attributes

FillEffectFadeAttribute Value

Private Member Functions

BOOL CopyNodeContents (AttrFillEffectFade *NodeCopy)
 This method copies the node's contents to the node pointed to by NodeCopy.

Detailed Description

RGB Fade fill effect Attribute class.

Author:
Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/07/94
See also:
FillEffectFadeAttribute

Definition at line 2690 of file fillattr2.h.

Constructor & Destructor Documentation

AttrFillEffectFade::AttrFillEffectFade (   )  [inline]
 

Definition at line 2695 of file fillattr2.h.

02695 {}

AttrFillEffectFade::AttrFillEffectFade (  Node *  ContextNode,
AttachNodeDirection  Direction,
BOOL  Locked = FALSE,
BOOL  Mangled = FALSE,
BOOL  Marked = FALSE,
BOOL  Selected = FALSE
)  [inline]
 

Definition at line 2696 of file fillattr2.h.

02701                                      : 
02702         AttrFillEffect(ContextNode, Direction, Locked, Mangled, Marked, Selected) {}

Member Function Documentation

BOOL AttrFillEffectFade::CopyNodeContents (  AttrFillEffectFade *  NodeCopy  )  [private]
 

This method copies the node's contents to the node pointed to by NodeCopy.

Author:
Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
Date:
23/8/94
Parameters:
NodeCopy - the node to copy. [INPUTS]
A copy of this node [OUTPUTS]
Returns:
Errors: An assertion failure will occur if NodeCopy is NULL Scope: protected

Definition at line 18758 of file fillattr.cpp.

18759 {
18760     ERROR2IF(NodeCopy == NULL, FALSE, "NULL pointer in AttrFillEffectFade::CopyNodeContents!");
18761 
18762     NodeAttribute::CopyNodeContents(NodeCopy);
18763 
18764     // Copy contents specific to derived class here
18765     NodeCopy->Value.SimpleCopy(&Value);
18766     return TRUE;
18767 }

virtual AttributeValue* AttrFillEffectFade::GetAttributeValue (   )  [inline, virtual]
 

Reimplemented from NodeAttribute.

Definition at line 2710 of file fillattr2.h.

02710 { return &Value; }

UINT32 AttrFillEffectFade::GetAttrNameID (  void   )  [virtual]
 

Returns a string resource ID describing the attribute.

Author:
Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
Date:
23/8/94
Returns:
Attribute description ID

Reimplemented from NodeAttribute.

Definition at line 18738 of file fillattr.cpp.

18739 {
18740     return (_R(IDS_FILLEFFECTFADE)); 
18741 }

UINT32 AttrFillEffectFade::GetNodeSize (   )  const [virtual]
 

For finding the size of the node.

Author:
Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
Date:
23/8/94
Returns:
The size of the node in bytes
See also:
Node::GetSubtreeSize

Reimplemented from Node.

Definition at line 18805 of file fillattr.cpp.

18806 {     
18807     return (sizeof(AttrFillEffectFade)); 
18808 }

void AttrFillEffectFade::PolyCopyNodeContents (  NodeRenderable *  pNodeCopy  )  [virtual]
 

Polymorphically copies the contents of this node to another.

Author:
Phil_Martin (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/12/2003
Parameters:
- [OUTPUTS]
Returns:
Errors: An assertion failure will occur if NodeCopy is NULL Scope: protected

Reimplemented from NodeRenderable.

Definition at line 18782 of file fillattr.cpp.

18783 {
18784     ENSURE(pNodeCopy, "Trying to copy a node's contents into a NULL node");
18785     ENSURE(IS_A(pNodeCopy, AttrFillEffectFade), "PolyCopyNodeContents given wrong dest node type");
18786 
18787     if (IS_A(pNodeCopy, AttrFillEffectFade))
18788         CopyNodeContents((AttrFillEffectFade*)pNodeCopy);
18789 }

void AttrFillEffectFade::Render (  RenderRegion *  pRender  )  [virtual]
 

'Renders' a RGB fade fill effect attribute.

Author:
Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
Date:
23/8/94

Reimplemented from NodeAttribute.

Definition at line 18695 of file fillattr.cpp.

18696 {
18697     pRender->SetFillEffect(&Value, FALSE);
18698 }

Node * AttrFillEffectFade::SimpleCopy (  void   )  [virtual]
 

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.

Author:
Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
Date:
23/8/94
Returns:
A copy of the node, or NULL if memory runs out

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

Reimplemented from NodeAttribute.

Definition at line 18716 of file fillattr.cpp.

18717 {
18718     AttrFillEffectFade* NodeCopy = new AttrFillEffectFade();
18719     if (NodeCopy == NULL)
18720         return NULL;
18721 
18722     CopyNodeContents(NodeCopy);
18723     
18724     return NodeCopy;
18725 }

BOOL AttrFillEffectFade::WritePreChildrenNative (  BaseCamelotFilter *  pFilter  )  [virtual]
 

Reimplemented from Node.

Definition at line 18839 of file fillattr.cpp.

18840 {
18841 #ifdef DO_EXPORT
18842     return WritePreChildrenWeb(pFilter);
18843 #else
18844     return FALSE;
18845 #endif
18846 }

BOOL AttrFillEffectFade::WritePreChildrenWeb (  BaseCamelotFilter *  pFilter  )  [virtual]
 

Writes the fade fill effect record to the filter.

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

Author:
Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>
Date:
30/5/96
Parameters:
pFilter = ptr to the filter [INPUTS]
Returns:
TRUE if record is written, FALSE if not
See also:
-

Reimplemented from Node.

Definition at line 18824 of file fillattr.cpp.

18825 {
18826 #ifdef DO_EXPORT
18827     ERROR2IF(pFilter == NULL,FALSE,"NULL filter param");
18828 
18829     CamelotFileRecord Rec(pFilter,TAG_FILLEFFECT_FADE,TAG_FILLEFFECT_FADE_SIZE);
18830     return pFilter->Write(&Rec);
18831 #else
18832     return FALSE;
18833 #endif
18834 }

Member Data Documentation

FillEffectFadeAttribute AttrFillEffectFade::Value
 

Definition at line 2721 of file fillattr2.h.

The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:50:14 2007 for Camelot by  doxygen 1.4.4