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

ValueFunctionRampS Class Reference

#include <valfunc.h>

Inheritance diagram for ValueFunctionRampS:

ValueFunctionRamp ValueFunction ListItem CCObject SimpleCCObject List of all members.

Public Member Functions

 ValueFunctionRampS (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 (ValueFunctionRampS)

Detailed Description

Definition at line 406 of file valfunc.h.

Constructor & Destructor Documentation

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

Definition at line 411 of file valfunc.h.

00412                     :   ValueFunctionRamp(StartValue, EndValue)
00413                     {};

Member Function Documentation

ValueFunctionRampS::CC_DECLARE_DYNAMIC (  ValueFunctionRampS   )  [private]
 

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

Clone operator. Creates an exact copy of this object.

Author:
Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
Date:
8/1/97
Returns:
NULL if it failed, else an exact copy of this object

Implements ValueFunction.

Definition at line 1207 of file valfunc.cpp.

01208 {
01209     ValueFunction *pClone = new ValueFunctionRampS(Value1, Value2);
01210     return(pClone);
01211 }

ValueFunction * ValueFunctionRampS::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:
Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
Date:
27/1/97
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 1242 of file valfunc.cpp.

01243 {
01244     ERROR3IF(pInputRecord == NULL, "Illegal NULL param");
01245 
01246     float Value1 = (float) 1.0;
01247     float Value2 = (float) 0.0;
01248 
01249     pInputRecord->ReadFLOAT(&Value1);
01250     pInputRecord->ReadFLOAT(&Value2);
01251 
01252     return(new ValueFunctionRampS((double) Value1, (double) Value2));
01253 }

INT32 ValueFunctionRampS::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 1188 of file valfunc.cpp.

01189 {
01190     return 2;
01191 }

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

Implements ValueFunction.

Definition at line 419 of file valfunc.h.

00419 { return(ValueFunctionID_RampS); };

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

To read the value of this function at a given position.

Author:
Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
Date:
30/12/96
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: RampS is a half sine-wave "S" shaped function

Implements ValueFunction.

Definition at line 1168 of file valfunc.cpp.

01169 {
01170     const double MixValue   = (cos(Position * Pi) + 1.0) / 2.0;
01171 
01172     return((MixValue * Value1) + ((1.0 - MixValue) * Value2));
01173 }

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