OpenSceneGraph 2.8.4
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
osg::AlphaFunc Class Reference

Encapsulates OpenGL glAlphaFunc. More...

Inheritance diagram for osg::AlphaFunc:
Inheritance graph
[legend]

List of all members.

Public Types

enum  ComparisonFunction {
  NEVER = GL_NEVER, LESS = GL_LESS, EQUAL = GL_EQUAL, LEQUAL = GL_LEQUAL,
  GREATER = GL_GREATER, NOTEQUAL = GL_NOTEQUAL, GEQUAL = GL_GEQUAL, ALWAYS = GL_ALWAYS
}

Public Member Functions

 AlphaFunc ()
 AlphaFunc (ComparisonFunction func, float ref)
 AlphaFunc (const AlphaFunc &af, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
 META_StateAttribute (osg, AlphaFunc, ALPHAFUNC)
virtual int compare (const StateAttribute &sa) const
 Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
virtual bool getModeUsage (StateAttribute::ModeUsage &usage) const
 Return the modes associated with this StateAttribute.
void setFunction (ComparisonFunction func, float ref)
void setFunction (ComparisonFunction func)
ComparisonFunction getFunction () const
void setReferenceValue (float value)
float getReferenceValue () const
virtual void apply (State &state) const
 apply the OpenGL state attributes.

Protected Member Functions

virtual ~AlphaFunc ()

Protected Attributes

ComparisonFunction _comparisonFunc
float _referenceValue

Detailed Description

Encapsulates OpenGL glAlphaFunc.


Member Enumeration Documentation

Enumerator:
NEVER 
LESS 
EQUAL 
LEQUAL 
GREATER 
NOTEQUAL 
GEQUAL 
ALWAYS 

Constructor & Destructor Documentation

osg::AlphaFunc::AlphaFunc ( )
osg::AlphaFunc::AlphaFunc ( ComparisonFunction  func,
float  ref 
) [inline]
osg::AlphaFunc::AlphaFunc ( const AlphaFunc af,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
) [inline]

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::AlphaFunc::~AlphaFunc ( ) [protected, virtual]

Member Function Documentation

virtual void osg::AlphaFunc::apply ( State ) const [virtual]

apply the OpenGL state attributes.

The render info for the current OpenGL context is passed in to allow the StateAttribute to obtain details on the the current context and state.

Reimplemented from osg::StateAttribute.

virtual int osg::AlphaFunc::compare ( const StateAttribute sa) const [inline, virtual]

Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.

Implements osg::StateAttribute.

References COMPARE_StateAttribute_Parameter, and COMPARE_StateAttribute_Types.

ComparisonFunction osg::AlphaFunc::getFunction ( ) const [inline]
virtual bool osg::AlphaFunc::getModeUsage ( StateAttribute::ModeUsage ) const [inline, virtual]

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

References osg::StateAttribute::ModeUsage::usesMode().

float osg::AlphaFunc::getReferenceValue ( ) const [inline]
osg::AlphaFunc::META_StateAttribute ( osg  ,
AlphaFunc  ,
ALPHAFUNC   
)
void osg::AlphaFunc::setFunction ( ComparisonFunction  func) [inline]
void osg::AlphaFunc::setFunction ( ComparisonFunction  func,
float  ref 
) [inline]
void osg::AlphaFunc::setReferenceValue ( float  value) [inline]

Member Data Documentation


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

osg logo
Generated at Sun Jan 8 2012 13:16:03 for the OpenSceneGraph by doxygen 1.7.4.