VariableWidthAttrValue Class Reference

VariableWidth attribute value VariableWidth attributes describe the width characteristics for a path. More...

#include <strkattr.h>

Inheritance diagram for VariableWidthAttrValue:

List of all members.

Public Member Functions
	VariableWidthAttrValue (ValueFunction *pValueFunction=NULL)
	Constuctor for VariableWidthAttrValue.
	~VariableWidthAttrValue ()
	Destructor for VariableWidthAttrValue.
virtual void	Render (RenderRegion *pRegion, BOOL Temp=FALSE)
	Sets the VariableWidthAttrValue attribute for the given render region.
virtual void	Restore (RenderRegion *pRegion, BOOL Temp)
	Restores the VariableWidthAttrValue attribute for the given render region.
virtual void	SimpleCopy (AttributeValue *pValue)
	See AttributeValue::SimpleCopy.
virtual NodeAttribute *	MakeNode ()
	Make a new attribute node for this type of attr value - see base class.
virtual BOOL	IsDifferent (AttributeValue *pAttr)
	Determines if this AttrValue is different from the given one.
virtual VariableWidthAttrValue &	operator= (VariableWidthAttrValue &Attrib)
	Assignment operator.
virtual INT32	operator== (const VariableWidthAttrValue &Attrib)
	Comparison operator.
void	SetWidthFunction (VariableWidthID PredefinedFuncID)
	To set the width function used in stroking.
void	SetWidthFunction (ValueFunction *pNewFunction)
	To set the width function used in stroking.
ValueFunction *	GetWidthFunction (void)
VariableWidthID	GetWidthFunctionID (void)
Static Public Member Functions
static BOOL	Init (void)
	Registers a default attribute of this type with the attribute manager.
Private Attributes
VariableWidthID	PredefinedFunctionID
ValueFunction *	WidthFunction

---

Detailed Description

VariableWidth attribute value VariableWidth attributes describe the width characteristics for a path.

Author:

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

Date:

7/1/97

Definition at line 275 of file strkattr.h.

---

Constructor & Destructor Documentation

VariableWidthAttrValue::VariableWidthAttrValue (  ValueFunction *  pValueFunction = NULL  )

Constuctor for VariableWidthAttrValue. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/1/97 Parameters: pValueFunction  - NULL (for simple constant-width "line") or a ValueFunction [INPUTS] describing the variable width of paths affected by this attr. NOTE that this object now BELONGS to the new attr, and will be deleted automatically when this object is destructed Definition at line 1400 of file strkattr.cpp. { WidthFunction = pValueFunction; PredefinedFunctionID = VarWidth_NotPredefined; }

VariableWidthAttrValue::~VariableWidthAttrValue (   )

Destructor for VariableWidthAttrValue. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/1/97 Definition at line 1419 of file strkattr.cpp. { if (WidthFunction != NULL) delete WidthFunction; }

---

Member Function Documentation

ValueFunction* VariableWidthAttrValue::GetWidthFunction (  void   )  [inline]

Definition at line 303 of file strkattr.h. { return(WidthFunction); };

VariableWidthID VariableWidthAttrValue::GetWidthFunctionID (  void   )  [inline]

Definition at line 304 of file strkattr.h. { return(PredefinedFunctionID); };

BOOL VariableWidthAttrValue::Init (  void   )  [static]

Registers a default attribute of this type with the attribute manager. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/1/97 Returns: TRUE if it initilised successfully Reimplemented from SimpleCCObject. Definition at line 1440 of file strkattr.cpp. { // The default attribute is one that has no effect (i.e. produces constant-width "lines") VariableWidthAttrValue *pAttr = new VariableWidthAttrValue; if (pAttr == NULL) return FALSE; UINT32 ID = AttributeManager::RegisterDefaultAttribute(CC_RUNTIME_CLASS(VariableWidthAttrValue), pAttr); ERROR2IF(ID == ATTR_BAD_ID, FALSE, "Bad ID when Initialising VariableWidthAttrValue"); return(TRUE); }

BOOL VariableWidthAttrValue::IsDifferent (  AttributeValue *  pAttr  )  [virtual]

Determines if this AttrValue is different from the given one. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/1/97 Returns: Errors: ERROR3 if the two attributes are not of the same type See also: AttributeValue::IsDifferent Reimplemented from AttributeValue. Definition at line 1577 of file strkattr.cpp. { ERROR3IF(!pAttr->IsKindOf(CC_RUNTIME_CLASS(VariableWidthAttrValue)), "Different attribute types in VariableWidthAttrValue::IsDifferent()"); // Check they are NOT the same using the == operator return ( !(*((VariableWidthAttrValue *)pAttr) == *this) ); }

NodeAttribute * VariableWidthAttrValue::MakeNode (   )  [virtual]

Make a new attribute node for this type of attr value - see base class. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/1/97 Returns: Pointer to the new node, or NULL if out of memory. See also: AttributeValue::MakeNode Reimplemented from AttributeValue. Definition at line 1546 of file strkattr.cpp. { // Create new attribute node AttrVariableWidth *pAttr = new AttrVariableWidth(); if (pAttr == NULL) return NULL; // Copy attribute value (if any) into the new node. if (pAttr->GetAttributeValue() != NULL) pAttr->GetAttributeValue()->SimpleCopy(this); return(pAttr); }

VariableWidthAttrValue & VariableWidthAttrValue::operator= (  VariableWidthAttrValue &  Attrib  )  [virtual]

Assignment operator. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/1/97 Parameters: Attrib  - the attribute to copy [INPUTS] Definition at line 1601 of file strkattr.cpp. { // Delete our existing WidthFunction (if any) if (WidthFunction != NULL) delete WidthFunction; WidthFunction = NULL; // Try to clone the other attribute's width function. If this fails, we'll just // end up as a constant-width line (NULL ValueFunction pointer) if (Attrib.GetWidthFunction() != NULL) WidthFunction = Attrib.GetWidthFunction()->Clone(); // And copy its ID member across too PredefinedFunctionID = Attrib.PredefinedFunctionID; return(*this); }

INT32 VariableWidthAttrValue::operator== (  const VariableWidthAttrValue &  Attrib  )  [virtual]

Comparison operator. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/1/97 Parameters: Attrib  - the attribute to compare this attribute with [INPUTS] Returns: TRUE if the attributes are considered equal Definition at line 1636 of file strkattr.cpp. { ERROR3IF(!Attrib.IsKindOf(CC_RUNTIME_CLASS(VariableWidthAttrValue)), "Other attribute value isn't an VariableWidthAttrValue"); // VariableWidthAttrValue *Other = (VariableWidthAttrValue *) &Attrib; // If both width functions are NULL, we are equal if (WidthFunction == NULL && Attrib.WidthFunction == NULL) return(TRUE); // If only one function is NULL, we ca't be considered equal if (WidthFunction == NULL || Attrib.WidthFunction == NULL) return(FALSE); // Finally, if both have a valid width function, ask them if they're equal return(!WidthFunction->IsDifferent(Attrib.WidthFunction)); }

void VariableWidthAttrValue::Render (  RenderRegion *  pRegion, BOOL  Temp = FALSE )  [virtual]

Sets the VariableWidthAttrValue attribute for the given render region. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/1/97 Parameters: pRegion  - the render region to render this attribute into. [INPUTS] Notes: This attribute is so simple that its state can be read directly off the render region's stack. Thus, there is minimal special render region support for this attribute - we just stack and unstack it directly here. Implements AttributeValue. Definition at line 1474 of file strkattr.cpp. { pRegion->SetVariableWidth(this, Temp); }

void VariableWidthAttrValue::Restore (  RenderRegion *  pRegion, BOOL  Temp )  [virtual]

Restores the VariableWidthAttrValue attribute for the given render region. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/1/97 Parameters: pRegion  - the render region to restore the attribute into. [INPUTS] Temp - TRUE if this is a temporary attribute, FALSE if it is permanent (e.g. it's in a document tree). Notes: This attribute is so simple that its state can be read directly off the render region's stack. Thus, there is minimal special render region support for this attribute - we just stack and unstack it directly here. Implements AttributeValue. Definition at line 1500 of file strkattr.cpp. { pRegion->RestoreVariableWidth(this, Temp); }

void VariableWidthAttrValue::SetWidthFunction (  ValueFunction *  pNewFunction  )

To set the width function used in stroking. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/1/97 Parameters: pNewFunction  - The new value function to use for variable-width strokes [INPUTS] affected by this attribute. May be NULL, in which case all strokes will be simple constant-width strokes. NOTE that this object now belongs to this Attr, and will be automatically deleted upon destruction of the attr. Notes: See the alternative form of this method - it uses predefined function "shapes", which save in a more compact format. Definition at line 1678 of file strkattr.cpp. { if (WidthFunction != NULL) delete WidthFunction; WidthFunction = pNewFunction; PredefinedFunctionID = VarWidth_NotPredefined; }

void VariableWidthAttrValue::SetWidthFunction (  VariableWidthID  PredefinedFuncID  )

To set the width function used in stroking. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/1/97 Parameters: PredefinedFuncID  - The ID of which predefined width function type you [INPUTS] wish to use. Predefined types are used to save space in the file format when exporting simple variable width attributes. Definition at line 1704 of file strkattr.cpp. { ERROR3IF(PredefinedFuncID == VarWidth_NotPredefined, "You what?!"); // get rid of any old width function if (WidthFunction != NULL) { delete WidthFunction; WidthFunction = NULL; } // Remember the new predefined-width-function identifier, so that we // know that our width is a spaecial predefined form which can be saved // in a much simpler & smaller format PredefinedFunctionID = PredefinedFuncID; switch(PredefinedFunctionID) { case VarWidth_Constant: WidthFunction = new ValueFunctionConstant(1.0); break; case VarWidth_LinRamp: WidthFunction = new ValueFunctionRampLinear(1.0, 0.0); break; case VarWidth_SRamp: WidthFunction = new ValueFunctionRampS(1.0, 0.0); break; default: ERROR3("Unsupported predefined width function"); break; } }

void VariableWidthAttrValue::SimpleCopy (  AttributeValue *  pValue  )  [virtual]

See AttributeValue::SimpleCopy. Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> Date: 7/1/97 Parameters: pValue  - pointer to the AttributeValue to copy [INPUTS] Implements AttributeValue. Definition at line 1520 of file strkattr.cpp. { ERROR3IF(!IS_A(pValue, VariableWidthAttrValue), "Invalid Attribute value passed to VariableWidthAttrValue::SimpleCopy"); // Just uses the assignment operator *this = *((VariableWidthAttrValue *) pValue); }

---

Member Data Documentation

VariableWidthID VariableWidthAttrValue::PredefinedFunctionID [private]

Definition at line 304 of file strkattr.h.

ValueFunction* VariableWidthAttrValue::WidthFunction [private]

Definition at line 308 of file strkattr.h.

---

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

• Kernel/strkattr.h (r1785/r1688)
• Kernel/strkattr.cpp (r1785/r1688)

---