Visualization Library 2.0.0-b3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Attributes | List of all members
vl::Fog Class Reference

RenderState wrapping the OpenGL function glFog(), see also http://www.opengl.org/sdk/docs/man/xhtml/glFog.xml for more information. More...

#include <Shader.hpp>

+ Inheritance diagram for vl::Fog:

Public Member Functions

 Fog (EFogMode mode=FM_LINEAR, const fvec4 &color=fvec4(0, 0, 0, 0), float density=1, float start=0, float end=1)
 
virtual ERenderState type () const
 
virtual void apply (int index, const Camera *, OpenGLContext *ctx) const
 The parameter cameara is NULL if we are disabling the state, non-NULL if we are enabling it. More...
 
void set (EFogMode mode, const fvec4 &color, float density, float start, float end)
 
void setColor (const fvec4 &color)
 
void setMode (EFogMode mode)
 
void setDensity (float density)
 
void setStart (float start)
 
void setEnd (float end)
 
const fvec4color () const
 
EFogMode mode () const
 
float density () const
 
float start () const
 
float end () const
 
virtual ref< RenderStateclone () const
 
- Public Member Functions inherited from vl::RenderStateNonIndexed
 RenderStateNonIndexed ()
 
- Public Member Functions inherited from vl::RenderState
 RenderState ()
 
- Public Member Functions inherited from vl::Object
 Object ()
 Constructor. More...
 
 Object (const Object &other)
 Copy constructor: copies the name, ref count mutex and user data. More...
 
Objectoperator= (const Object &other)
 Copy operator: copies the object's name, ref count mutex and user data. More...
 
const std::string & objectName () const
 The name of the object, by default set to the object's class name. More...
 
void setObjectName (const char *name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setObjectName (const std::string &name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setRefCountMutex (IMutex *mutex)
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () const
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
int referenceCount () const
 Returns the number of references of an object. More...
 
void incReference () const
 Increments the reference count of an object. More...
 
void decReference ()
 Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
 
void setAutomaticDelete (bool autodel_on)
 If set to true the Object is deleted when its reference count reaches 0. More...
 
bool automaticDelete () const
 If set to true the Object is deleted when its reference count reaches 0. More...
 
template<class T >
T * as ()
 Casts an Object to the specified class. More...
 
template<class T >
const T * as () const
 Casts an Object to the specified class. More...
 

Protected Attributes

fvec4 mColor
 
EFogMode mMode
 
float mDensity
 
float mStart
 
float mEnd
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Additional Inherited Members

- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 

Detailed Description

RenderState wrapping the OpenGL function glFog(), see also http://www.opengl.org/sdk/docs/man/xhtml/glFog.xml for more information.

See also
Shader, Effect, Actor, vl::EN_FOG

Definition at line 907 of file Shader.hpp.

Constructor & Destructor Documentation

◆ Fog()

vl::Fog::Fog ( EFogMode  mode = FM_LINEAR,
const fvec4 color = fvec4(0,0,0,0),
float  density = 1,
float  start = 0,
float  end = 1 
)
inline

Definition at line 912 of file Shader.hpp.

Member Function Documentation

◆ apply()

void Fog::apply ( int  index,
const Camera camera,
OpenGLContext ctx 
) const
virtual

The parameter cameara is NULL if we are disabling the state, non-NULL if we are enabling it.

Implements vl::RenderState.

Definition at line 541 of file Shader.cpp.

References VL_CHECK_OGL.

◆ clone()

virtual ref<RenderState> vl::Fog::clone ( ) const
inlinevirtual

Implements vl::RenderState.

Definition at line 944 of file Shader.hpp.

◆ color()

const fvec4& vl::Fog::color ( ) const
inline

Definition at line 934 of file Shader.hpp.

◆ density()

float vl::Fog::density ( ) const
inline

Definition at line 938 of file Shader.hpp.

◆ end()

float vl::Fog::end ( ) const
inline

Definition at line 942 of file Shader.hpp.

◆ mode()

EFogMode vl::Fog::mode ( ) const
inline

Definition at line 936 of file Shader.hpp.

◆ set()

void vl::Fog::set ( EFogMode  mode,
const fvec4 color,
float  density,
float  start,
float  end 
)
inline

Definition at line 922 of file Shader.hpp.

◆ setColor()

void vl::Fog::setColor ( const fvec4 color)
inline

Definition at line 924 of file Shader.hpp.

◆ setDensity()

void vl::Fog::setDensity ( float  density)
inline

Definition at line 928 of file Shader.hpp.

◆ setEnd()

void vl::Fog::setEnd ( float  end)
inline

Definition at line 932 of file Shader.hpp.

◆ setMode()

void vl::Fog::setMode ( EFogMode  mode)
inline

Definition at line 926 of file Shader.hpp.

◆ setStart()

void vl::Fog::setStart ( float  start)
inline

Definition at line 930 of file Shader.hpp.

◆ start()

float vl::Fog::start ( ) const
inline

Definition at line 940 of file Shader.hpp.

◆ type()

virtual ERenderState vl::Fog::type ( ) const
inlinevirtual

Reimplemented from vl::RenderState.

Definition at line 918 of file Shader.hpp.

References vl::RS_Fog.

Member Data Documentation

◆ mColor

fvec4 vl::Fog::mColor
protected

Definition at line 952 of file Shader.hpp.

◆ mDensity

float vl::Fog::mDensity
protected

Definition at line 954 of file Shader.hpp.

◆ mEnd

float vl::Fog::mEnd
protected

Definition at line 956 of file Shader.hpp.

◆ mMode

EFogMode vl::Fog::mMode
protected

Definition at line 953 of file Shader.hpp.

◆ mStart

float vl::Fog::mStart
protected

Definition at line 955 of file Shader.hpp.


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