Drag[en]gine Game Engine  1.0
deEffectDistortImage Class Reference

Effect Distort Image Class. More...

#include <deEffectDistortImage.h>

Inheritance diagram for deEffectDistortImage:
deEffect deResource deObject

Public Member Functions

Management
deImageGetImage () const
 
void SetImage (deImage *image)
 
const decVector2GetTextureCoordinatesFor (int corner) const
 
void SetTextureCoordinatesFor (int corner, const decVector2 &textureCoordinates)
 
float GetStrengthU () const
 
void SetStrengthU (float strength)
 
float GetStrengthV () const
 
void SetStrengthV (float strength)
 
Visiting
virtual void Visit (deEffectVisitor *visitor)
 
- Public Member Functions inherited from deEffect
bool GetEnabled () const
 
void SetEnabled (bool enabled)
 
deBaseGraphicEffectGetGraphicEffect () const
 
void SetGraphicEffect (deBaseGraphicEffect *graEffect)
 
 deEffect (deEffectManager *manager)
 
- Public Member Functions inherited from deResource
deResourceManagerGetResourceManager () const
 Resource manager or NULL if resource is leaking. More...
 
deEngineGetEngine () const
 Game engine object from resource manager. More...
 
deResourceGetLLManagerPrev () const
 Previous resource in the resource manager linked list. More...
 
void SetLLManagerPrev (deResource *resource)
 Set next resource in the resource manager linked list. More...
 
deResourceGetLLManagerNext () const
 Next resource in the resource manager linked list. More...
 
void SetLLManagerNext (deResource *resource)
 Set next resource in the resource manager linked list. More...
 
void MarkLeaking ()
 Marks the resource leaking. More...
 
 deResource (deResourceManager *resourceManager)
 Create resource. More...
 
- Public Member Functions inherited from deObject
int GetRefCount () const
 Reference count. More...
 
void AddReference ()
 Add reference increasing reference count by 1. More...
 
void FreeReference ()
 Decrease reference count by one and delete object if count reaches 0. More...
 
 deObject ()
 Create object with reference count of 1. More...
 

Constructors and Destructors

 deEffectDistortImage (deEffectManager *manager)
 
virtual ~deEffectDistortImage ()
 Clean up effect distort image. More...
 

Additional Inherited Members

- Protected Member Functions inherited from deEffect
virtual ~deEffect ()
 Clean up world. More...
 
- Protected Member Functions inherited from deResource
virtual ~deResource ()
 Clean up resource. More...
 
- Protected Member Functions inherited from deObject
virtual ~deObject ()
 Clean up object. More...
 

Detailed Description

Effect Distort Image Class.

The distort image effect applies a distortion to the rendered image using a normal map type image. The red and green channel are used as an offset to look up the pixel from the rendered image. The offset is first multiplied by the strength factor.

Author
Pl├╝ss Roland
Version
1.0
Date
2008

Constructor & Destructor Documentation

◆ deEffectDistortImage()

deEffectDistortImage::deEffectDistortImage ( deEffectManager manager)

Creates a new effect distort image.

◆ ~deEffectDistortImage()

virtual deEffectDistortImage::~deEffectDistortImage ( )
protectedvirtual

Clean up effect distort image.

Note
Subclasses should set their destructor protected too to avoid users accidently deleting a reference counted object through the object pointer. Only FreeReference() is allowed to delete the object.

Member Function Documentation

◆ GetImage()

deImage* deEffectDistortImage::GetImage ( ) const
inline

Retrieves the image or null if not set.

References GetTextureCoordinatesFor(), SetImage(), and SetTextureCoordinatesFor().

◆ GetStrengthU()

float deEffectDistortImage::GetStrengthU ( ) const
inline

Retrieves the strength in u direction.

References SetStrengthU().

◆ GetStrengthV()

float deEffectDistortImage::GetStrengthV ( ) const
inline

Retrieves the strength in v direction.

References SetStrengthV(), and Visit().

◆ GetTextureCoordinatesFor()

const decVector2& deEffectDistortImage::GetTextureCoordinatesFor ( int  corner) const

Retrieves the texture coordinates of the given corner.

Referenced by GetImage().

◆ SetImage()

void deEffectDistortImage::SetImage ( deImage image)

Sets the image or null to remove it.

Referenced by GetImage().

◆ SetStrengthU()

void deEffectDistortImage::SetStrengthU ( float  strength)

Sets the strength in u direction.

Referenced by GetStrengthU().

◆ SetStrengthV()

void deEffectDistortImage::SetStrengthV ( float  strength)

Sets the strength in v direction.

Referenced by GetStrengthV().

◆ SetTextureCoordinatesFor()

void deEffectDistortImage::SetTextureCoordinatesFor ( int  corner,
const decVector2 textureCoordinates 
)

Sets the texture coordinates if the given corner.

Referenced by GetImage().

◆ Visit()

virtual void deEffectDistortImage::Visit ( deEffectVisitor visitor)
virtual

Visits the effect.

Reimplemented from deEffect.

Referenced by GetStrengthV().


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