LineWidthAttribute Class Reference

Represent a line width of a path. This may be a simple stroking operator such as a constant line width, or a complex one such as variable line widths or an airbrush stroke operator. More...

#include <attrval.h>

Inheritance diagram for LineWidthAttribute:

List of all members.

Public Member Functions
	LineWidthAttribute ()
	LineWidthAttribute (MILLIPOINT NewLineWidth)
virtual void	Restore (RenderRegion *, BOOL)
	Restores the line width attribute for the given render region. i.e. all lines drawn will now be drawn with this line width.
virtual void	Render (RenderRegion *, BOOL Temp=FALSE)
	Sets the line width attribute for the given render region. i.e. all lines drawn will now be drawn with this line width.
virtual NodeAttribute *	MakeNode ()
	Make a AttrLineWidth node from this line width attribute.
BOOL	IsDifferent (AttributeValue *pAttr)
	See base class version.
virtual void	SimpleCopy (AttributeValue *)
	See AttributeValue::SimpleCopy.
virtual BOOL	Blend (BlendAttrParam *pBlendParam)
	Blends this attr val with the attr val held in pBlendParam.
virtual BOOL	RenderStroke (RenderRegion *, Path *)
virtual AttributeValue *	MouldIntoStroke (PathStrokerVector *pMoulder, double TransScale=1.0)
	Helper function for the PathStrokerVector class, which "moulds" clipart subtrees to lie along an arbitrary path.
Static Public Member Functions
static BOOL	Init ()
	Registers line width attribute, and provides a default attribute to give 0.25pt lines.
Public Attributes
MILLIPOINT	LineWidth

---

Detailed Description

Represent a line width of a path. This may be a simple stroking operator such as a constant line width, or a complex one such as variable line widths or an airbrush stroke operator.

Author:

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

Date:

15/06/94

See also:

FillColourAttribute; StrokeColourAttribute; StartArrowAttribute; EndArrowAttribute; StartCapAttribute; EndCapAttribute; JoinTypeAttribute; MitreLimitAttribute; WindingRuleAttribute; DashPatternAttribute

Definition at line 193 of file attrval.h.

---

Constructor & Destructor Documentation

LineWidthAttribute::LineWidthAttribute (   )

Definition at line 386 of file attr.cpp. { LineWidth = 500 + 1; // BODGE The 1 added by Simon 25/10/95, so that the default attr // is different from the current attr. That way line scaling at // least works in simple cases. }

LineWidthAttribute::LineWidthAttribute (  MILLIPOINT  NewLineWidth  )  [inline]

Definition at line 198 of file attrval.h. { LineWidth = NewLineWidth; }

---

Member Function Documentation

BOOL LineWidthAttribute::Blend (  BlendAttrParam *  pBlendParam  )  [virtual]

Blends this attr val with the attr val held in pBlendParam. Author: Mark_Neves (Xara Group Ltd) <camelotdev@xara.com> Date: 26/10/94 Parameters: pBlendParam  = ptr to param holding all data needed for the attr val to blend [INPUTS] if  TRUE returned, pBlendParam->GetBlendedAttrVal() will get ptr to the blended attr val [OUTPUTS] if FALSE returned, pBlendParam->GetBlendedAttrVal() will return NULL Returns: TRUE if successful, FALSE otherwaie See also: - Reimplemented from AttributeValue. Definition at line 542 of file attr.cpp. { // Check entry param ERROR3IF(pBlendParam == NULL,"NULL entry param"); if (pBlendParam == NULL) return FALSE; LineWidthAttribute* pOtherLineAttr = (LineWidthAttribute*) pBlendParam->GetOtherAttrVal(); // Check that the other line attr val is not NULL, and is a LineWidthAttribute ERROR3IF(pOtherLineAttr == NULL,"NULL other attr val"); ERROR3IF(!IS_A(pOtherLineAttr,LineWidthAttribute),"other attr val not a line width attr"); if (pOtherLineAttr == NULL || !IS_A(pOtherLineAttr,LineWidthAttribute)) return FALSE; // Get a new LineWidthAttribute to hold the blended version, (return FALSE if this fails) LineWidthAttribute* pBlendedLineAttr = new LineWidthAttribute; if (pBlendedLineAttr == NULL) return FALSE; // The blended line width is done by linearly tending the start line width to the // end line width, proportionally to the blend ration (0.0 to 1.0) // DeltaWidth is the amount to subtract from this LineWidth, and is proportional to BlendRatio MILLIPOINT DeltaWidth = INT32((LineWidth - pOtherLineAttr->LineWidth) * pBlendParam->GetBlendRatio()); pBlendedLineAttr->LineWidth = LineWidth - DeltaWidth; // Store the ptr to the new blended line width attr val pBlendParam->SetBlendedAttrVal(pBlendedLineAttr); return TRUE; }

BOOL LineWidthAttribute::Init (  void   )  [static]

Registers line width attribute, and provides a default attribute to give 0.25pt lines. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 11/04/94 Returns: TRUE - initialised ok; FALSE if not. Errors: Out of memory. See also: AttributeManager Reimplemented from SimpleCCObject. Definition at line 468 of file attr.cpp. { // Default to 0.25pt lines LineWidthAttribute *pAttr = new LineWidthAttribute; if (pAttr == NULL) return FALSE; UINT32 ID = AttributeManager::RegisterDefaultAttribute(CC_RUNTIME_CLASS(NodeRenderableInk), pAttr); if (ID == ATTR_BAD_ID) return FALSE; ENSURE(ID == ATTR_LINEWIDTH, "Incorrect ID for attribute!"); return TRUE; }

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

See base class version. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 12/04/94 Returns: Errors: The two attributes are not of the same type. See also: AttributeValue::IsDifferent Reimplemented from AttributeValue. Definition at line 520 of file attr.cpp. { ENSURE(GetRuntimeClass() == pAttr->GetRuntimeClass(), "Different attribute types in AttributeValue::IsDifferent()"); return ((LineWidthAttribute *) pAttr)->LineWidth != LineWidth; }

NodeAttribute * LineWidthAttribute::MakeNode (   )  [virtual]

Make a AttrLineWidth node from this line width attribute. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 11/04/94 Returns: Pointer to the new node, or NULL if out of memory. Errors: Out of memory See also: AttributeValue::MakeNode Reimplemented from AttributeValue. Definition at line 496 of file attr.cpp. { // Create new attribute node AttrLineWidth *pAttr = new AttrLineWidth(); // Copy attribute value into the new node. pAttr->Value.SimpleCopy(this); // Return the new node return pAttr; }

AttributeValue * LineWidthAttribute::MouldIntoStroke (  PathStrokerVector *  pMoulder, double  TransScale = 1.0 )  [virtual]

Helper function for the PathStrokerVector class, which "moulds" clipart subtrees to lie along an arbitrary path. Parameters: pMoulder  - A PathStrokerVector which knows how to translate points to "mould" them [INPUTS] (May be NULL, in which case moulding of points does not occur) TransScale - A fraction between 0.0 and 1.0, by which any transparency values in this geometry will be scaled, allowing the caller to effectively apply a flat transparency level to everything that is moulded. Use 1.0 to leave transparency unaltered. Returns: NULL if there is no need to mould this attribute (so you should just render the original attribute), else A pointer to a copy of this object, suitably moulded and adjusted for the transparency scaling. The caller must delete the copy when finished with it. This function is called to mould attributes, so that: Fill/Trans geometries can be moulded Line Widths can be scaled to an appropriate value A global flat transparency can be applied etc Notes: The base class does nothing (it returns NULL - by default, attrs assume that they will work OK when moulded without being changed) Reimplemented from AttributeValue. Definition at line 608 of file attr.cpp. { #ifdef VECTOR_STROKING // Neville 6/8/97 LineWidthAttribute* pMouldedAttr = new LineWidthAttribute; if (pMouldedAttr != NULL) { double ScaledWidth = pMoulder->GetScaleFactor() * (double)LineWidth; if (ScaledWidth < 1.0) ScaledWidth = 1.0; else if (pMouldedAttr->LineWidth > 1000000.0) ScaledWidth = 1000000.0; pMouldedAttr->LineWidth = (INT32)ScaledWidth; } return(pMouldedAttr); #else return NULL; #endif }

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

Sets the line width attribute for the given render region. i.e. all lines drawn will now be drawn with this line width. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 03/02/94 Parameters: pRegion  - the render region to render this attribute into. [INPUTS] See also: LineWidthAttribute; RenderStack; AttributeValue; NodeAttribute; LineWidthAttribute::Restore; LineWidthAttribute::SimpleCopy; AttributeValue::Render; AttributeValue::Restore; AttributeValue::SimpleCopy Implements AttributeValue. Definition at line 408 of file attr.cpp. { pRegion->SetLineWidth(this, Temp); }

virtual BOOL LineWidthAttribute::RenderStroke (  RenderRegion *  , Path *  )  [inline, virtual]

Definition at line 209 of file attrval.h. { return FALSE; }

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

Restores the line width attribute for the given render region. i.e. all lines drawn will now be drawn with this line width. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 03/02/94 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). See also: LineWidthAttribute; RenderStack; AttributeValue; NodeAttribute; LineWidthAttribute::Render; LineWidthAttribute::SimpleCopy; AttributeValue::Render; AttributeValue::Restore; AttributeValue::SimpleCopy Implements AttributeValue. Definition at line 430 of file attr.cpp. { pRegion->RestoreLineWidth(this, Temp); }

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

See AttributeValue::SimpleCopy. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 03/02/94 Parameters: pAttr  - pointer to the AttributeValue to copy. [INPUTS] See also: LineWidthAttribute; RenderStack; AttributeValue; NodeAttribute; LineWidthAttribute::Render; LineWidthAttribute::Restore; AttributeValue::Render; AttributeValue::Restore; AttributeValue::SimpleCopy Implements AttributeValue. Definition at line 449 of file attr.cpp. { LineWidth = ((LineWidthAttribute *) pValue)->LineWidth; }

---

Member Data Documentation

MILLIPOINT LineWidthAttribute::LineWidth

Definition at line 212 of file attrval.h.

---

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

• Kernel/attrval.h (r1785/r1445)
• Kernel/attr.cpp (r1785/r1361)

---