Drag[en]gine Game Engine  1.0
deEffectOverlayImage Class Reference

Effect overlay image. More...

#include <deEffectOverlayImage.h>

Inheritance diagram for deEffectOverlayImage:
deEffect deResource deObject

Public Member Functions

Management
deImageGetImage () const
 Image or NULL if not set. More...
 
void SetImage (deImage *image)
 Set image or NULL if not set. More...
 
const decVector2GetTextureCoordinatesFor (int corner) const
 Texture coordinates for corner. More...
 
void SetTextureCoordinatesFor (int corner, const decVector2 &textureCoordinates)
 Set texture coordinates for corner. More...
 
float GetTransparency () const
 Transparency. More...
 
void SetTransparency (float transparency)
 Set transparency. More...
 
Visiting
virtual void Visit (deEffectVisitor *visitor)
 Visit effect. More...
 
- 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

 deEffectOverlayImage (deEffectManager *manager)
 Create effect overlay image. More...
 
virtual ~deEffectOverlayImage ()
 Clean up effect overlay 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 overlay image.

The overlay image effect simply renders a predefined image over the existing render output. The image can occupy any part of the existing image using the texture coordinates. The image has to contain transparency to work best although you can specify an additional transparency yourself. Furthermore additional effects can be applied to this image ( effect chaining ) before applying it.

Author
Pl├╝ss Roland
Version
1.0
Date
2015

Constructor & Destructor Documentation

◆ deEffectOverlayImage()

deEffectOverlayImage::deEffectOverlayImage ( deEffectManager manager)

Create effect overlay image.

◆ ~deEffectOverlayImage()

virtual deEffectOverlayImage::~deEffectOverlayImage ( )
protectedvirtual

Clean up effect overlay 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* deEffectOverlayImage::GetImage ( ) const
inline

Image or NULL if not set.

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

◆ GetTextureCoordinatesFor()

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

Texture coordinates for corner.

Exceptions
deeOutOfBoundarycorner is less than 0 or greater than 3.

Referenced by GetImage().

◆ GetTransparency()

float deEffectOverlayImage::GetTransparency ( ) const
inline

Transparency.

References SetTransparency(), and Visit().

◆ SetImage()

void deEffectOverlayImage::SetImage ( deImage image)

Set image or NULL if not set.

Referenced by GetImage().

◆ SetTextureCoordinatesFor()

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

Set texture coordinates for corner.

Exceptions
deeOutOfBoundarycorner is less than 0 or greater than 3.

Referenced by GetImage().

◆ SetTransparency()

void deEffectOverlayImage::SetTransparency ( float  transparency)

Set transparency.

Referenced by GetTransparency().

◆ Visit()

virtual void deEffectOverlayImage::Visit ( deEffectVisitor visitor)
virtual

Visit effect.

Reimplemented from deEffect.

Referenced by GetTransparency().


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