osg::AlphaFunc Class Reference

Inheritance diagram for osg::AlphaFunc:

osg::StateAttribute osg::Object osg::Referenced

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)
 META_StateAttribute (osg, AlphaFunc, ALPHAFUNC)
virtual int compare (const StateAttribute &sa) const
virtual bool getModeUsage (StateAttribute::ModeUsage &usage) const
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

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

osg::AlphaFunc::META_StateAttribute ( osg  ,
AlphaFunc  ,
ALPHAFUNC   
)

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.

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().

void osg::AlphaFunc::setFunction ( ComparisonFunction  func,
float  ref 
) [inline]

void osg::AlphaFunc::setFunction ( ComparisonFunction  func  )  [inline]

ComparisonFunction osg::AlphaFunc::getFunction (  )  const [inline]

void osg::AlphaFunc::setReferenceValue ( float  value  )  [inline]

float osg::AlphaFunc::getReferenceValue (  )  const [inline]

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.


Member Data Documentation


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

Generated on Wed Nov 17 16:52:48 2010 for openscenegraph by  doxygen 1.5.6