IStrokeParameters Class Reference

#include <istrokeparameters.h>

Inheritance diagram for IStrokeParameters:

Public Types
enum	{ kDefaultIID = IID_ISTROKEPARAMETERS }

Public Member Functions
virtual int32	GetParamCount () const =0
virtual void	SetParamCount (int32 count)=0
virtual PMReal	GetNthParamStart (int32 n) const =0
virtual void	SetNthParamStart (int32 n, PMReal const &start)=0
virtual PMReal	GetNthParamWidth (int32 n) const =0
virtual void	SetNthParamWidth (int32 n, PMReal const &width)=0
virtual bool16	IsEqual (IStrokeParameters const *other) const =0
virtual int32	Canonicalize ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Stores parameters used by the scotch rules stroker. Each parameter consists of a pair of values: one that specifies the start position as a percentage of the stroke weight, and one that specifies the width (also as a percentage)

Member Function Documentation

virtual int32 IStrokeParameters::Canonicalize ( )

pure virtual

Canonicalizes parameters: normalizes start/width pairs, sorts by start value, then collapses overlapping pairs

Returns

The new parameter count

virtual PMReal IStrokeParameters::GetNthParamStart ( int32  n ) const

pure virtual

Returns the start value for the specified parameter

Parameters

n	IN The index of the desired parameter

Returns

The parameter's start value

virtual PMReal IStrokeParameters::GetNthParamWidth ( int32  n ) const

pure virtual

Returns the width value for the specified parameter

Parameters

n	IN The index of the desired parameter

Returns

The parameter's width value

virtual int32 IStrokeParameters::GetParamCount ( ) const

pure virtual

Returns the number of parameters in this object

Returns

number of parameters

virtual bool16 IStrokeParameters::IsEqual ( IStrokeParameters const *  other ) const

pure virtual

Tests for equivalence

Parameters

other

IN The object against which this object is to be tested

Returns

kTrue if two objects are equivalent, else kFalse

virtual void IStrokeParameters::SetNthParamStart ( int32  n, PMReal const &  start  )

pure virtual

Sets the start value for the specified parameter

Parameters

n	IN The index of the desired parameter
start	IN The parameter's start value

virtual void IStrokeParameters::SetNthParamWidth ( int32  n, PMReal const &  width  )

pure virtual

Sets the width value for the specified parameter

Parameters

n	IN The index of the desired parameter
width	IN The parameter's width value

virtual void IStrokeParameters::SetParamCount ( int32  count )

pure virtual

Sets the number of parameters in this object

Parameters

count

IN The number of parameters this object should hold