ValueFunctionRampL2 Class Reference

#include <valfunc.h>

Inheritance diagram for ValueFunctionRampL2:

List of all members.

Public Member Functions
	ValueFunctionRampL2 (double StartValue=1.0, double EndValue=0.2)
virtual double	GetValue (double Position)
	To read the value of this function at a given position.
virtual ValueFunction *	Clone (void)
	Clone operator. Creates an exact copy of this object.
virtual INT32	GetMinimumRecursionDepth ()
	Overriden function to indicate to the path stroker how many recursions to perform at minimum before declaring a line segment 'flat' enough.
virtual ValueFunctionID	GetUniqueID (void)
Protected Member Functions
virtual ValueFunction *	CreateAndReadFileRecord (CXaraFileRecord *pInputRecord)
	Loads a ValueFunction object from a record which was saved into a file using the WriteFileRecord call. This is called by the base class loader routine ReadFileRecord, which finds an appropriate instance of a derived class to call to load the data in question.
Private Member Functions
	CC_DECLARE_DYNAMIC (ValueFunctionRampL2)

---

Detailed Description

Definition at line 472 of file valfunc.h.

---

Constructor & Destructor Documentation

ValueFunctionRampL2::ValueFunctionRampL2 (  double  StartValue = 1.0, double  EndValue = 0.2 )  [inline]

Definition at line 477 of file valfunc.h. : ValueFunctionRamp(StartValue, EndValue) {};

---

Member Function Documentation

ValueFunctionRampL2::CC_DECLARE_DYNAMIC (  ValueFunctionRampL2   )  [private]

ValueFunction * ValueFunctionRampL2::Clone (  void   )  [virtual]

Clone operator. Creates an exact copy of this object. Author: Priestley (Xara Group Ltd) <camelotdev@xara.com> from Jason Date: 9/10/2000 Returns: NULL if it failed, else an exact copy of this object Implements ValueFunction. Definition at line 1526 of file valfunc.cpp. { ValueFunction *pClone = new ValueFunctionRampL2(Value1, Value2); return(pClone); }

ValueFunction * ValueFunctionRampL2::CreateAndReadFileRecord (  CXaraFileRecord *  pInputRecord  )  [protected, virtual]

Loads a ValueFunction object from a record which was saved into a file using the WriteFileRecord call. This is called by the base class loader routine ReadFileRecord, which finds an appropriate instance of a derived class to call to load the data in question. Author: Priestley (Xara Group Ltd) <camelotdev@xara.com> from Jason Date: 9/10/2000 Parameters: pInputRecord  - The file record to read [INPUTS] Returns: NULL if it failed, else a pointer to new ValueFunction object representing whatever was saved in that record. This method creates a new instance of this particular ValueFunction class and then loads whatever information is necessary from the file to initialise itself properly. The record read-pointer is left pointing at the end of the ValueFunction-saved data so that the caller can continue reading their extra bytes of data after loading the ValueFunction. See also: ValueFunctionRamp::WriteFileRecord Implements ValueFunction. Definition at line 1561 of file valfunc.cpp. { ERROR3IF(pInputRecord == NULL, "Illegal NULL param"); float Value1 = (float) 1.0; float Value2 = (float) 0.2; pInputRecord->ReadFLOAT(&Value1); pInputRecord->ReadFLOAT(&Value2); return(new ValueFunctionRampL2((double) Value1, (double) Value2)); }

INT32 ValueFunctionRampL2::GetMinimumRecursionDepth (   )  [virtual]

Overriden function to indicate to the path stroker how many recursions to perform at minimum before declaring a line segment 'flat' enough. Author: Priestley (Xara Group Ltd) <camelotdev@xara.com> Date: 9/10/2000 Reimplemented from ValueFunction. Definition at line 1507 of file valfunc.cpp. { return 2; }

virtual ValueFunctionID ValueFunctionRampL2::GetUniqueID (  void   )  [inline, virtual]

Implements ValueFunction. Definition at line 485 of file valfunc.h. { return(ValueFunctionID_RampL2); };

double ValueFunctionRampL2::GetValue (  double  Position  )  [virtual]

To read the value of this function at a given position. Author: Priestley (Xara Group Ltd) <camelotdev@xara.com> from Jason Date: 9/10/2000 Parameters: Position  - A value between 0.0 and 1.0 [INPUTS] Returns: A value (between Value1 and Value2 given in the constructor) representing the value of the function at the given Position. Notes: RampL is a half sine-wave "S" shaped function Implements ValueFunction. Definition at line 1487 of file valfunc.cpp. { const double MixValue = cos((Pi/2.0) + (Position * Pi/2.0)) + 1.0; return((MixValue * Value1) + ((1.0 - MixValue) * Value2)); }

---

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

• Kernel/valfunc.h (r1785/r1282)
• Kernel/valfunc.cpp (r1785/r1517)

---