Skip to content
- [Main Page](index.md) - [Classes](annotated.md) - [Files](files.md) - [Directories](dirs.md) - [Related Pages](pages.md)
- [Class List](annotated.md) - [Alphabetical List](classes.md) - [Class Hierarchy](hierarchy.md) - [Class Members](functions.md)

Turbulence Class Reference

Base class for all turbulences. More...

#include <Turbulen.h>

Inheritance diagram for Turbulence:

Inheritance graph

[legend]

Collaboration diagram for Turbulence:

Collaboration graph

[legend]

List of all members.


Public Member Functions
  Turbulence (HTreeObject *treeobject)
virtual float  Evaluate (const Vector &evalp)=0

Detailed Description

Base class for all turbulences.

To write a turbulence plug-in for Animation Master you must derive a class from the Turbulence class provided in "Turbulen.h". The derivation should look something like this:

class MyCoolTurbulence : public Turbulence;

Once you have declared your new class, you can begin overriding the virtual functions found in the Turbulence base class or in the DLLPlugin base class. You will need to override nearly every function in the base classes to have a completely functional new turbulence.

Definition at line 11 of file Turbulen.h.

Constructor & Destructor Documentation

Turbulence::Turbulence (  HTreeObject *  htreeobject  )  [inline]
 
Parameters:
htreeobject  - is a pointer to the plugins owner. It is the class that the Texture is member of. It is the actual class you see in the PWS tree. The constructor only uses it to set the member variable m_treeobject. This member is used for ReAssignPtr. This is also the pointer returned by GetOwner().
See also:
DLLPlugin::DLLPlugin (HTreeObject *htreeobject)

Definition at line 13 of file Turbulen.h.

Member Function Documentation

float Turbulence::Evaluate (  const Vector &  evalp  )  [pure virtual]
 

Every time a surface is encountered during rendering that has your texture on it, Evaluate is called. This gives you the ability to set what the surface's parameters are.

Parameters:
evalp  - The 3D coordinate that you should evaluate is passed to you in the form of a Vector. This 3D coordinate is the coordinate as computed on the cached object surface. This means that the render time world coordinate on an object surface is reverse transformed to the cached surface. This prevents the texture from floating on the surface as the surface is being deformed from muscle or skeletal actions.
Returns:
The value returned should normally be between 0.0 and 1.0 and indicates the mix between the two attributes that are defined in the turbulence as ((Attr1 * retval) + (Attr2 * (1.0 - retval))). Any negative return value is absoluted to positive value and any value greater than 1.0 is clipped to 1.0.
See also:
HObjectCache for a description of cached objects.

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

This A:M SDK v12.0 documentation is maintained by Hash Inc. Please address any comments concerning this documentation to AMReports. If you have any information, knowledge, or documentation to share with the A:M developer community, please post them on the Hash SDK forum.

Generated on Thu Oct 27 11:47:04 2005 with doxygen 1.4.5 written by Dimitri van Heesch, © 1997-2001