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

ValueFunctionIntestine Class Reference

#include <valfunc.h>

Inheritance diagram for ValueFunctionIntestine:

ValueFunctionRamp ValueFunction ListItem CCObject SimpleCCObject List of all members.

Public Member Functions

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

Detailed Description

Definition at line 588 of file valfunc.h.

Constructor & Destructor Documentation

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

Definition at line 593 of file valfunc.h.

00594                     :   ValueFunctionRamp(StartValue, EndValue)
00595                     {};

Member Function Documentation

ValueFunctionIntestine::CC_DECLARE_DYNAMIC (  ValueFunctionIntestine   )  [private]
 

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

01961 {
01962     ValueFunction *pClone = new ValueFunctionIntestine(Value1, Value2);
01963     return(pClone);
01964 }

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

02013 {
02014     ERROR3IF(pInputRecord == NULL, "Illegal NULL param");
02015 
02016     float Value1 = (float) 1.0;
02017     float Value2 = (float) 0.0;
02018 
02019     pInputRecord->ReadFLOAT(&Value1);
02020     pInputRecord->ReadFLOAT(&Value2);
02021 
02022     return(new ValueFunctionIntestine((double) Value1, (double) Value2));
02023 }

INT32 ValueFunctionIntestine::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 1979 of file valfunc.cpp.

01980 {
01981     return 4;
01982 }

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

Implements ValueFunction.

Definition at line 602 of file valfunc.h.

00602 { return(ValueFunctionID_Intestine); };

double ValueFunctionIntestine::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 1939 of file valfunc.cpp.

01940 {
01941     const double MixValue   = ((cos(Position * 20.0 * Pi) + 3.0) / 4.0);
01942     return((MixValue * Value1) + ((1.0 - MixValue) * Value2));
01943 }

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