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

ValueFunctionRampS2 Class Reference

#include <valfunc.h>

Inheritance diagram for ValueFunctionRampS2:

ValueFunctionRamp ValueFunction ListItem CCObject SimpleCCObject List of all members.

Public Member Functions

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

Detailed Description

Definition at line 428 of file valfunc.h.

Constructor & Destructor Documentation

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

Definition at line 433 of file valfunc.h.

00434                     :   ValueFunctionRamp(StartValue, EndValue)
00435                     {};

Member Function Documentation

ValueFunctionRampS2::CC_DECLARE_DYNAMIC (  ValueFunctionRampS2   )  [private]
 

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

01297 {
01298     ValueFunction *pClone = new ValueFunctionRampS2(Value1, Value2);
01299     return(pClone);
01300 }

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

01332 {
01333     ERROR3IF(pInputRecord == NULL, "Illegal NULL param");
01334 
01335     float Value1 = (float) 1.0;
01336     float Value2 = (float) 0.2;
01337 
01338     pInputRecord->ReadFLOAT(&Value1);
01339     pInputRecord->ReadFLOAT(&Value2);
01340 
01341     return(new ValueFunctionRampS2((double) Value1, (double) Value2));
01342 }

INT32 ValueFunctionRampS2::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 1356 of file valfunc.cpp.

01357 {
01358     return 2;
01359 }

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

Implements ValueFunction.

Definition at line 441 of file valfunc.h.

00441 { return(ValueFunctionID_RampS2); };

double ValueFunctionRampS2::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: RampS2 is a half sine-wave "S" shaped function - Value2 set to none-zero

Implements ValueFunction.

Definition at line 1274 of file valfunc.cpp.

01275 {
01276     const double MixValue   = (cos(Position * Pi) + 1.0) / 2.0;
01277 
01278     return((MixValue * Value1) + ((1.0 - MixValue) * Value2));
01279 }

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