BlendRef Class Reference

Contains all the data that a NodeBlender needs about another node in the tree which it is blending. More...

#include <nodebldr.h>

Inheritance diagram for BlendRef:

List of all members.

Public Member Functions
	BlendRef ()
	Default constructor.
	~BlendRef ()
	Default destructor.
BOOL	Initialise (NodeRenderableInk *pThisNode, INT32 Index, UndoableOperation *pUndoOp, Progress *pProgress, BOOL IgnoreEscape, Trans2DMatrix *pMatrix, AttrBrushType *pAttrBrush=NULL)
	This inits the BlendRef object with the given node.This inits the BlendRef object with the given node.
BOOL	InitialiseForBrush (NodeRenderableInk *pThisNode)
	This inits the BlendRef object with the given node.
NodeRenderableInk *	GetNode ()
void	Transform (TransformBase &Trans)
	Transforms all the BlendPaths attached to this blend reference.
void	RenderBlendBlobs (RenderRegion *pRender, Trans2DMatrix *pMatrix)
	Renders all the blend blobs associated with all the blend paths in this blend ref.
void	PreBlend ()
	Called just before a blender node is about to do its blend. It asks all its blend paths to find their applied attributes.
void	PostBlend ()
	Called just after a blender node has done its blend. It asks all its blend paths to free their applied attributes.
CCAttrMap *	FindAppliedAttributes (BlendPath *pBlendPath)
	Use this to get the attrs of a blend path that belongs to this blend reference. It keeps its own map keyed by the node which created the blend path, so that FindAppliedAttributes() is only called once for each node that created blend paths, rather than once for every blend path produced by the node (potentially many).
BOOL	AddBlendPath (BlendPath *pBlendPath)
	Add the blend path object to this blend ref NOTE: Once you add a BlendPath to a BlendRef, it becomes property of the BlendRef which can alter/delete it at any time. DO NOT KEEP A COPY OF THE PTR pBlendPath!!!! It may not be there next time use it.
UINT32	GetNumBlendPaths ()
BlendPath *	GetFirstBlendPath ()
	Lets you get the first blend path in the list.
BlendPath *	GetNextBlendPath (BlendPath *pCurrentBlendPath)
	Lets you get the next blend path in the list.
BlendPath *	GetBlendPath (INT32 Index)
	Lets you get the nth blend path in the list.
BOOL	IsPointOverBlob (DocCoord *pPointerPos, BlendPath **ppBlendPath, INT32 *pIndex, Trans2DMatrix *pMatrix)
	This sees if the point given lies on a selected blob. If a match is found, the ptr to the blend path and index to blob element is returned.
INT32	GetOrigMapping ()
	The path in question could well have been remapping (i.e. rotated to change the el at index 0) many times. This func returns the mapping (i.e. the index of the el that should be at index 0) that should be appied to the original path in order to get the same result. If the ref has more than one blend path, -1 is returned, meaning choose a default element as the start node (e.g. left most, bottom most element).
void	SetAWComplex (BOOL state)
BOOL	GetAWComplex ()
DocRect	GetBoundingRect ()
BOOL	RemoveLastBlendPath ()
	Not a function that most people will have cause to use, removes the tail item in the blendpath list.
void	StripRedundantNodeBlendPaths (BlendRef *spouse)
	Strips redundant NodeBlendPaths from the blend refs. This is needed in the case that we are required to blend a blend on a both to a non-blend on a path (and vice versa).
Protected Attributes
NodeRenderableInk *	m_pNode
List	m_BlendPathList
UINT32	m_NumBlendPaths
CMapPtrToPtr *	m_pBlendPathAttrMap
BOOL	m_AWComplex
Private Member Functions
	CC_DECLARE_MEMDUMP (BlendRef)

---

Detailed Description

Contains all the data that a NodeBlender needs about another node in the tree which it is blending.

Author:

Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>

Date:

11/10/94

Definition at line 285 of file nodebldr.h.

---

Constructor & Destructor Documentation

BlendRef::BlendRef (   )

Default constructor. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Definition at line 4066 of file nodebldr.cpp. { m_pNode = NULL; m_NumBlendPaths = 0; m_pBlendPathAttrMap = NULL; }

BlendRef::~BlendRef (   )

Default destructor. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Definition at line 4086 of file nodebldr.cpp. { m_BlendPathList.DeleteAll(); DELPTR(m_pBlendPathAttrMap); }

---

Member Function Documentation

BOOL BlendRef::AddBlendPath (  BlendPath *  pBlendPath  )

Add the blend path object to this blend ref NOTE: Once you add a BlendPath to a BlendRef, it becomes property of the BlendRef which can alter/delete it at any time. DO NOT KEEP A COPY OF THE PTR pBlendPath!!!! It may not be there next time use it. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/94 Parameters: pBlendPath  = ptr to blend path to add [INPUTS] -  [OUTPUTS] Returns: TRUE if successfully initialises, FALSE otherwise Definition at line 4290 of file nodebldr.cpp. { m_BlendPathList.AddTail(pBlendPath); m_NumBlendPaths++; return TRUE; }

BlendRef::CC_DECLARE_MEMDUMP (  BlendRef   )  [private]

CCAttrMap * BlendRef::FindAppliedAttributes (  BlendPath *  pBlendPath  )

Use this to get the attrs of a blend path that belongs to this blend reference. It keeps its own map keyed by the node which created the blend path, so that FindAppliedAttributes() is only called once for each node that created blend paths, rather than once for every blend path produced by the node (potentially many). Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 16/11/94 Parameters: pBlendPath  = the blend path that has the attrs you want [INPUTS] -  [OUTPUTS] Returns: - Definition at line 4552 of file nodebldr.cpp. { // If the attrs applied to this blend path are unique to the blend path (i.e. not the same // as the attrs applid to the node that created the blend path) return the unique attrs if (pBlendPath->UniqueAppliedAttrs()) return (pBlendPath->FindAppliedAttributes()); // If we haven't got a map of attr maps yet, try the blend path directly if (m_pBlendPathAttrMap == NULL) return (pBlendPath->FindAppliedAttributes()); // pAttrMap will hold the attrs applied to pBlendPath CCAttrMap* pAttrMap = NULL; // the map of attr maps is keyed by the ptr to the node that created the blend path NodeRenderableInk* pCreatedByNode = pBlendPath->GetCreatedByNode(); if (pCreatedByNode->IsCompound()) { pCreatedByNode = ((NodeCompound *)pCreatedByNode)->GetNodeToBlend(); } if (pCreatedByNode != NULL) { // Do we have an attr map for pCreatedByNode? CMapPtrToPtr::iterator iter = m_pBlendPathAttrMap->find( pCreatedByNode ); if( m_pBlendPathAttrMap->end() != iter ) pAttrMap = (CCAttrMap *)iter->second; else { // If not, get the blend path to return us an attr map // and put the ptr in our map of attr maps, keyed by pCreatedByNode. pAttrMap = pBlendPath->FindAppliedAttributes(); if (pAttrMap != NULL) (*m_pBlendPathAttrMap)[pCreatedByNode] = pAttrMap; } } return pAttrMap; }

BOOL BlendRef::GetAWComplex (   )  [inline]

Definition at line 327 of file nodebldr.h. { return m_AWComplex; }

BlendPath * BlendRef::GetBlendPath (  INT32  Index  )

Lets you get the nth blend path in the list. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/94 Parameters: Index  = index of the list item (0 is the first item) [INPUTS] -  [OUTPUTS] Returns: Returns the blend path who's index is Index, or NULL if there isn't a next one See also: GetNumBlendPaths(); Definition at line 4348 of file nodebldr.cpp. { if (m_NumBlendPaths <= 0) return NULL; if (Index >= INT32(m_NumBlendPaths)) { ERROR3("Index too big"); Index = m_NumBlendPaths-1; } if (Index < 0) { ERROR3("Index is -ve "); Index = 0; } BlendPath* pBlendPath = GetFirstBlendPath(); while (pBlendPath != NULL && Index > 0) { pBlendPath = GetNextBlendPath(pBlendPath); Index--; } ERROR3IF(pBlendPath==NULL,"pBlendPath == NULL"); return (pBlendPath); }

DocRect BlendRef::GetBoundingRect (   )

Author: Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com> Date: 24/11/99 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: the bounding rect of all the blendpaths in the blendref Reimplemented in BrushRef. Definition at line 4608 of file nodebldr.cpp. { DocRect Rect; BlendPath *pBlendPath = GetFirstBlendPath(); while (pBlendPath != NULL) { DocRect PathRect = pBlendPath->m_pPath->GetBoundingRect(); Rect = Rect.Union(PathRect); pBlendPath = GetNextBlendPath(pBlendPath); } return Rect; }

BlendPath * BlendRef::GetFirstBlendPath (   )

Lets you get the first blend path in the list. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: First blend path in the list, or NULL if the list is empty Definition at line 4311 of file nodebldr.cpp. { return ((BlendPath*)m_BlendPathList.GetHead()); }

BlendPath * BlendRef::GetNextBlendPath (  BlendPath *  pCurrentBlendPath  )

Lets you get the next blend path in the list. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/94 Parameters: pCurrentBlendPath  = ptr the current blend path in the list [INPUTS] -  [OUTPUTS] Returns: Returns the next blend path after pCurrentBlendPath, or NULL if there isn't a next one Definition at line 4329 of file nodebldr.cpp. { return ((BlendPath*)m_BlendPathList.GetNext(pCurrentBlendPath)); }

NodeRenderableInk* BlendRef::GetNode (   )  [inline]

Definition at line 312 of file nodebldr.h. { return m_pNode; }

UINT32 BlendRef::GetNumBlendPaths (   )  [inline]

Definition at line 320 of file nodebldr.h. { return m_NumBlendPaths; }

INT32 BlendRef::GetOrigMapping (   )

The path in question could well have been remapping (i.e. rotated to change the el at index 0) many times. This func returns the mapping (i.e. the index of the el that should be at index 0) that should be appied to the original path in order to get the same result. If the ref has more than one blend path, -1 is returned, meaning choose a default element as the start node (e.g. left most, bottom most element). Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 11/11/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: The mapping that should be applied to the original path See also: - Definition at line 4470 of file nodebldr.cpp. { INT32 Mapping = -1; if (GetNumBlendPaths() == 1) { BlendPath* pBlendPath = GetFirstBlendPath(); if (pBlendPath != NULL) Mapping = pBlendPath->GetOrigMapping(); } return Mapping; }

BOOL BlendRef::Initialise (  NodeRenderableInk *  pThisNode, INT32  Index, UndoableOperation *  pUndoOp, Progress *  pProgress, BOOL  IgnoreEscape, Trans2DMatrix *  pMatrix, AttrBrushType *  pAttrBrush = NULL )

This inits the BlendRef object with the given node.This inits the BlendRef object with the given node. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/94 Parameters: pThisNode  = ptr to the node in the tree this BlendRef refers to. [INPUTS] Index = index into path of blob clicked on (-1 means ignore) pUndoOp = ptr to an undoable op so that initialisation can be done in an undoable way (can be NULL) pProgress = ptr to progress object for maintaining hour glass IgnoreEscape= TRUE if you don't want this process abortable via the Escape key pMatrix = transformation to apply to each blend path (can be NULL) pAttrBrush = the brush attribute applying to pThisNode, using this parameter indicates that you wish to extract paths from the brush. -  [OUTPUTS] Returns: TRUE if successfully initialises, FALSE otherwise Definition at line 4169 of file nodebldr.cpp. { ERROR2IF(pThisNode == NULL,FALSE,"pThisNode == NULL"); // Reset the member vars of this blend reference m_pNode = pThisNode; m_NumBlendPaths = 0; m_BlendPathList.DeleteAll(); // Set up a BecomeA derived object, so that we can receive all the paths generated by pNode. BlendBecomeA ParamBecomeA( BECOMEA_PASSBACK, CC_RUNTIME_CLASS(NodePath), pUndoOp, this, Index, pProgress, IgnoreEscape, pMatrix); ERROR2IF(!pThisNode->CanBecomeA(&ParamBecomeA), FALSE, "pThisNode can't become a NodePath!"); BOOL ok = FALSE; if (pAttrBrush != NULL) { // check to see if it is default, if it is not then let the attribute do the work if (pAttrBrush->GetBrushHandle() != BrushHandle_NoBrush) ok = pAttrBrush->DoBecomeA(&ParamBecomeA, pThisNode); else ok = m_pNode->DoBecomeA(&ParamBecomeA); } else // Get pNode to generate its paths for us ok = m_pNode->DoBecomeA(&ParamBecomeA); if (!ok) { // tidy up if things go wrong m_pNode = NULL; m_NumBlendPaths = 0; m_BlendPathList.DeleteAll(); } return (ok); }

BOOL BlendRef::InitialiseForBrush (  NodeRenderableInk *  pThisNode  )

This inits the BlendRef object with the given node. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/94 Parameters: pThisNode  = ptr to the node in the tree this BlendRef refers to. [INPUTS] -  [OUTPUTS] Returns: TRUE if successfully initialises, FALSE otherwise Definition at line 4231 of file nodebldr.cpp. { ERROR2IF(pThisNode == NULL,FALSE,"pThisNode == NULL"); // Reset the member vars of this blend reference m_pNode = pThisNode; m_NumBlendPaths = 0; m_BlendPathList.DeleteAll(); // Set up a BecomeA derived object, so that we can receive all the paths generated by pNode. BrushBecomeA MyBecomeA(BECOMEA_PASSBACK, CC_RUNTIME_CLASS(NodePath), NULL, this); ERROR2IF(!pThisNode->CanBecomeA(&MyBecomeA), FALSE, "pThisNode can't become a NodePath!"); // if we've got a stroke attribute applied then we must make a special case /* AttrStrokeType* pStroke = NULL; AttrVariableWidth* pVarWidth = NULL; pThisNode->FindAppliedAttribute(CC_RUNTIME_CLASS(AttrStrokeType), (NodeAttribute**)&pStroke); pThisNode->FindAppliedAttribute(CC_RUNTIME_CLASS(AttrVariableWidth), (NodeAttribute**)&pVarWidth); BOOL ok = FALSE; if (pStroke && pVarWidth && pVarWidth->HasActiveValueFunction()) ok = pStroke->DoBecomeA(&BecomeA, m_pNode); else */ BOOL ok = m_pNode->DoBecomeA(&MyBecomeA); if (!ok) { // tidy up if things go wrong m_pNode = NULL; m_NumBlendPaths = 0; m_BlendPathList.DeleteAll(); } return (ok); }

BOOL BlendRef::IsPointOverBlob (  DocCoord *  pPointerPos, BlendPath **  ppBlendPath, INT32 *  pIndex, Trans2DMatrix *  pMatrix )

This sees if the point given lies on a selected blob. If a match is found, the ptr to the blend path and index to blob element is returned. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 10/11/94 Parameters: pPointerPos  = point to check against [INPUTS] ppBlendPath = ptr to place to store blend path ptr if a match is found pIndex = ptr to place to store index if match is found pMatrix = matrix to apply to the path points before testing with pointer pos (can be NULL) *ppBlendPath  & *pIndex, updated if TRUE returned, undefined otherwise [OUTPUTS] Returns: TRUE if match found, FALSE otherwise Markn 26-5-99: Modified so that if the function returns TRUE, *pPointerPos is updated so that it contains the coords of the blob it is over See also: - Definition at line 4435 of file nodebldr.cpp. { if (pPointerPos == NULL) return FALSE; if (GetNumBlendPaths() != 1) return FALSE; BOOL Found = FALSE; BlendPath* pBlendPath = GetFirstBlendPath(); if (pBlendPath != NULL) { Found = pBlendPath->IsPointOverBlob(pPointerPos,pIndex,pMatrix); if (Found) *ppBlendPath = pBlendPath; } return Found; }

void BlendRef::PostBlend (   )

Called just after a blender node has done its blend. It asks all its blend paths to free their applied attributes. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 16/11/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Definition at line 4521 of file nodebldr.cpp. { // Free up any memory used to hold applied attribute tables in the blend paths BlendPath* pBlendPath = GetFirstBlendPath(); while (pBlendPath != NULL) { pBlendPath->FreeAppliedAttributes(); pBlendPath = GetNextBlendPath(pBlendPath); } // Remove all the items in the map of blend path attr maps if (m_pBlendPathAttrMap != NULL) m_pBlendPathAttrMap->clear(); }

void BlendRef::PreBlend (   )

Called just before a blender node is about to do its blend. It asks all its blend paths to find their applied attributes. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 16/11/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Definition at line 4499 of file nodebldr.cpp. { // If we haven't got a blend path attr map yet, make one (don't worry if we fail) if (m_pBlendPathAttrMap == NULL && m_NumBlendPaths > 0) PORTNOTE("other","Maps aren't hash bashed, so have no initial size") m_pBlendPathAttrMap = new CMapPtrToPtr(); // (m_NumBlendPaths); }

BOOL BlendRef::RemoveLastBlendPath (   )

Not a function that most people will have cause to use, removes the tail item in the blendpath list. Author: Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com> Date: 24/11/99 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if successful, FALSE if not Definition at line 4728 of file nodebldr.cpp. { if (m_BlendPathList.IsEmpty()) return FALSE; m_BlendPathList.RemoveTail(); m_NumBlendPaths--; return TRUE; }

void BlendRef::RenderBlendBlobs (  RenderRegion *  pRender, Trans2DMatrix *  pMatrix )

Renders all the blend blobs associated with all the blend paths in this blend ref. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 9/11/94 Parameters: pRender  = region to render blobs into. [INPUTS] pMatrix = matrix to apply to the blob coords -  [OUTPUTS] Returns: - Definition at line 4403 of file nodebldr.cpp. { BlendPath* pBlendPath = GetFirstBlendPath(); while (pBlendPath != NULL) { pBlendPath->RenderBlendBlobs(pRender,pMatrix); pBlendPath = GetNextBlendPath(pBlendPath); } }

void BlendRef::SetAWComplex (  BOOL  state  )  [inline]

Definition at line 326 of file nodebldr.h. { m_AWComplex = state; }

void BlendRef::StripRedundantNodeBlendPaths (  BlendRef *  spouse  )

Strips redundant NodeBlendPaths from the blend refs. This is needed in the case that we are required to blend a blend on a both to a non-blend on a path (and vice versa). Author: Chris_Snook (Xara Group Ltd) <camelotdev@xara.com> Date: 25/7/2000 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Definition at line 4639 of file nodebldr.cpp. { INT32 numbBlendPathInited = 0, spouseNumbBlendPathInited = 0; BlendPath *pBlendPath = GetFirstBlendPath(); while (pBlendPath != NULL) { if (pBlendPath->GetCreatedViaNodeBlendPath ()) { numbBlendPathInited++; } pBlendPath = GetNextBlendPath(pBlendPath); } pBlendPath = spouse->GetFirstBlendPath(); while (pBlendPath != NULL) { if (pBlendPath->GetCreatedViaNodeBlendPath ()) { spouseNumbBlendPathInited++; } pBlendPath = spouse->GetNextBlendPath(pBlendPath); } // only strip in this case .... if (numbBlendPathInited != spouseNumbBlendPathInited) { if ((numbBlendPathInited == 0) && (spouseNumbBlendPathInited > 0)) { // strip our spouse .... pBlendPath = spouse->GetFirstBlendPath(); while (pBlendPath != NULL) { if (pBlendPath->GetCreatedViaNodeBlendPath ()) { BlendPath* remover = pBlendPath; pBlendPath = spouse->GetNextBlendPath(pBlendPath); delete (spouse->m_BlendPathList.RemoveItem (remover)); spouse->m_NumBlendPaths--; } else { pBlendPath = spouse->GetNextBlendPath(pBlendPath); } } } else if ((spouseNumbBlendPathInited == 0) && (numbBlendPathInited > 0)) { // strip ourselves .... pBlendPath = GetFirstBlendPath(); while (pBlendPath != NULL) { if (pBlendPath->GetCreatedViaNodeBlendPath ()) { BlendPath* remover = pBlendPath; pBlendPath = GetNextBlendPath(pBlendPath); delete (m_BlendPathList.RemoveItem (remover)); m_NumBlendPaths--; } else { pBlendPath = GetNextBlendPath(pBlendPath); } } } // else - oh well } }

void BlendRef::Transform (  TransformBase &  Trans  )

Transforms all the BlendPaths attached to this blend reference. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/94 Parameters: Trans  - The transform Object [INPUTS] Definition at line 4378 of file nodebldr.cpp. { BlendPath* pBlendPath = GetFirstBlendPath(); while (pBlendPath != NULL) { pBlendPath->Transform(Trans); pBlendPath = GetNextBlendPath(pBlendPath); } }

---

Member Data Documentation

BOOL BlendRef::m_AWComplex [protected]

Definition at line 345 of file nodebldr.h.

List BlendRef::m_BlendPathList [protected]

Reimplemented in BrushRef. Definition at line 342 of file nodebldr.h.

UINT32 BlendRef::m_NumBlendPaths [protected]

Reimplemented in BrushRef. Definition at line 343 of file nodebldr.h.

CMapPtrToPtr* BlendRef::m_pBlendPathAttrMap [protected]

Reimplemented in BrushRef. Definition at line 344 of file nodebldr.h.

NodeRenderableInk* BlendRef::m_pNode [protected]

Reimplemented in BrushRef. Definition at line 341 of file nodebldr.h.

---

The documentation for this class was generated from the following files:

• Kernel/nodebldr.h (r1785/r1282)
• Kernel/nodebldr.cpp (r1785/r1315)

---