Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Search for 

ValueFunctionDecay Class Reference

#include <valfunc.h>

Inheritance diagram for ValueFunctionDecay:

ValueFunctionRamp ValueFunction ListItem CCObject SimpleCCObject List of all members.

Public Member Functions

 ValueFunctionDecay (double StartValue=1.0, double EndValue=0.0)
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 (ValueFunctionDecay)

Detailed Description

Definition at line 611 of file valfunc.h.

Constructor & Destructor Documentation

ValueFunctionDecay::ValueFunctionDecay (  double  StartValue = 1.0,
double  EndValue = 0.0
)  [inline]
 

Definition at line 616 of file valfunc.h.

00617                     :   ValueFunctionRamp(StartValue, EndValue)
00618                         {};

Member Function Documentation

ValueFunctionDecay::CC_DECLARE_DYNAMIC (  ValueFunctionDecay   )  [private]
 

ValueFunction * ValueFunctionDecay::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 2061 of file valfunc.cpp.

02062 {
02063     ValueFunction *pClone = new ValueFunctionDecay(Value1, Value2);
02064     return(pClone);
02065 }

ValueFunction * ValueFunctionDecay::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 2113 of file valfunc.cpp.

02114 {
02115     ERROR3IF(pInputRecord == NULL, "Illegal NULL param");
02116 
02117     float Value1 = (float) 1.0;
02118     float Value2 = (float) 0.0;
02119 
02120     pInputRecord->ReadFLOAT(&Value1);
02121     pInputRecord->ReadFLOAT(&Value2);
02122 
02123     return(new ValueFunctionDecay((double) Value1, (double) Value2));
02124 }

INT32 ValueFunctionDecay::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 2080 of file valfunc.cpp.

02081 {
02082     return 4;
02083 }

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

Implements ValueFunction.

Definition at line 625 of file valfunc.h.

00625 { return(ValueFunctionID_Decay); };

double ValueFunctionDecay::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.

Implements ValueFunction.

Definition at line 2040 of file valfunc.cpp.

02041 {
02042     const double MixValue   = (1.0 - Position) * ((cos(Position * 20.0 * Pi) + 3.0) / 4.0);
02043     return MixValue;
02044 }

The documentation for this class was generated from the following files:
Generated on Sat Nov 10 04:02:47 2007 for Camelot by  doxygen 1.4.4