openscenegraph
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::Scissor Class Reference

#include <Scissor>

Inheritance diagram for osg::Scissor:
osg::StateAttribute osg::Object osg::Referenced

Public Member Functions

 Scissor ()
 Scissor (int x, int y, int width, int height)
 Scissor (const Scissor &vp, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_StateAttribute (osg, Scissor, SCISSOR)
virtual int compare (const StateAttribute &sa) const
virtual bool getModeUsage (StateAttribute::ModeUsage &usage) const
void setScissor (int x, int y, int width, int height)
void getScissor (int &x, int &y, int &width, int &height) const
int & x ()
int x () const
int & y ()
int y () const
int & width ()
int width () const
int & height ()
int height () const
virtual void apply (State &state) const
Public Member Functions inherited from osg::StateAttribute
 StateAttribute ()
 StateAttribute (const StateAttribute &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual Object * cloneType () const =0
virtual Object * clone (const CopyOp &) const =0
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual StateAttribute * asStateAttribute ()
virtual const StateAttribute * asStateAttribute () const
virtual Texture * asTexture ()
virtual const Texture * asTexture () const
virtual Type getType () const =0
virtual unsigned int getMember () const
TypeMemberPair getTypeMemberPair () const
virtual bool isTextureAttribute () const
bool operator< (const StateAttribute &rhs) const
bool operator== (const StateAttribute &rhs) const
bool operator!= (const StateAttribute &rhs) const
const ParentList & getParents () const
StateSet * getParent (unsigned int i)
const StateSet * getParent (unsigned int i) const
unsigned int getNumParents () const
void setShaderComponent (ShaderComponent *sc)
ShaderComponent * getShaderComponent ()
const ShaderComponent * getShaderComponent () const
virtual bool checkValidityOfAssociatedModes (osg::State &) const
void setUpdateCallback (StateAttributeCallback *uc)
StateAttributeCallback * getUpdateCallback ()
const StateAttributeCallback * getUpdateCallback () const
void setEventCallback (StateAttributeCallback *ec)
StateAttributeCallback * getEventCallback ()
const StateAttributeCallback * getEventCallback () const
virtual void compileGLObjects (State &) const
virtual void resizeGLObjectBuffers (unsigned int)
virtual void releaseGLObjects (State *=0) const
Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
std::string getCompoundClassName () const
virtual Node * asNode ()
virtual const Node * asNode () const
virtual NodeVisitor * asNodeVisitor ()
virtual const NodeVisitor * asNodeVisitor () const
virtual StateSet * asStateSet ()
virtual const StateSet * asStateSet () const
virtual Uniform * asUniform ()
virtual const Uniform * asUniform () const
virtual Camera * asCamera ()
virtual const Camera * asCamera () const
virtual Drawable * asDrawable ()
virtual const Drawable * asDrawable () const
virtual Callback * asCallback ()
virtual const Callback * asCallback () const
virtual CallbackObject * asCallbackObject ()
virtual const CallbackObject * asCallbackObject () const
virtual UserDataContainer * asUserDataContainer ()
virtual const UserDataContainer * asUserDataContainer () const
virtual ValueObject * asValueObject ()
virtual const ValueObject * asValueObject () const
virtual Image * asImage ()
virtual const Image * asImage () const
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void setName (const std::string &name)
void setName (const char *name)
const std::string & getName () const
void setDataVariance (DataVariance dv)
DataVariance getDataVariance () const
virtual void computeDataVariance ()
void setUserDataContainer (osg::UserDataContainer *udc)
template<class T>
void setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainer * getUserDataContainer ()
const osg::UserDataContainer * getUserDataContainer () const
osg::UserDataContainer * getOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
template<class T>
void setUserData (const ref_ptr< T > &ud)
virtual Referenced * getUserData ()
virtual const Referenced * getUserData () const
template<typename T>
bool getUserValue (const std::string &name, T &value) const
template<typename T>
void setUserValue (const std::string &name, const T &value)
template<typename T>
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referenced & operator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::Mutex * getRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSet * getObserverSet () const
ObserverSet * getOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const

Protected Member Functions

virtual ~Scissor ()
Protected Member Functions inherited from osg::StateAttribute
virtual ~StateAttribute ()
void addParent (osg::StateSet *object)
void removeParent (osg::StateSet *object)
Protected Member Functions inherited from osg::Object
virtual ~Object ()
Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

int _x
int _y
int _width
int _height
Protected Attributes inherited from osg::StateAttribute
ParentList _parents
ref_ptr< ShaderComponent > _shaderComponent
ref_ptr< StateAttributeCallback > _updateCallback
ref_ptr< StateAttributeCallback > _eventCallback
Protected Attributes inherited from osg::Object
std::string _name
DataVariance _dataVariance
osg::UserDataContainer * _userDataContainer
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Additional Inherited Members

Public Types inherited from osg::StateAttribute
enum  Values {
  OFF = 0x0 , ON = 0x1 , OVERRIDE = 0x2 , PROTECTED = 0x4 ,
  INHERIT = 0x8
}
enum  Type {
  TEXTURE , POLYGONMODE , POLYGONOFFSET , MATERIAL ,
  ALPHAFUNC , ANTIALIAS , COLORTABLE , CULLFACE ,
  FOG , FRONTFACE , LIGHT , POINT ,
  LINEWIDTH , LINESTIPPLE , POLYGONSTIPPLE , SHADEMODEL ,
  TEXENV , TEXENVFILTER , TEXGEN , TEXMAT ,
  LIGHTMODEL , BLENDFUNC , BLENDEQUATION , LOGICOP ,
  STENCIL , COLORMASK , DEPTH , VIEWPORT ,
  SCISSOR , BLENDCOLOR , MULTISAMPLE , CLIPPLANE ,
  COLORMATRIX , VERTEXPROGRAM , FRAGMENTPROGRAM , POINTSPRITE ,
  PROGRAM , CLAMPCOLOR , HINT , SAMPLEMASKI ,
  PRIMITIVERESTARTINDEX , CLIPCONTROL , VALIDATOR , VIEWMATRIXEXTRACTOR ,
  OSGNV_PARAMETER_BLOCK , OSGNVEXT_TEXTURE_SHADER , OSGNVEXT_VERTEX_PROGRAM , OSGNVEXT_REGISTER_COMBINERS ,
  OSGNVCG_PROGRAM , OSGNVSLANG_PROGRAM , OSGNVPARSE_PROGRAM_PARSER , UNIFORMBUFFERBINDING ,
  TRANSFORMFEEDBACKBUFFERBINDING , ATOMICCOUNTERBUFFERBINDING , PATCH_PARAMETER , FRAME_BUFFER_OBJECT ,
  VERTEX_ATTRIB_DIVISOR , SHADERSTORAGEBUFFERBINDING , INDIRECTDRAWBUFFERBINDING , VIEWPORTINDEXED ,
  DEPTHRANGEINDEXED , SCISSORINDEXED , BINDIMAGETEXTURE , SAMPLER ,
  CAPABILITY = 100
}
typedef GLenum GLMode
typedef unsigned int GLModeValue
typedef unsigned int OverrideValue
typedef std::pair< Type, unsigned int > TypeMemberPair
typedef std::vector< StateSet * > ParentList
typedef osg::StateAttributeCallback Callback
Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandler * getDeleteHandler ()

Detailed Description

Encapsulate OpenGL glScissor.

Constructor & Destructor Documentation

◆ Scissor() [1/3]

osg::Scissor::Scissor ( )

Referenced by compare(), META_StateAttribute(), and Scissor().

◆ Scissor() [2/3]

osg::Scissor::Scissor ( int x,
int y,
int width,
int height )
inline

References _height, _width, _x, _y, height(), width(), x(), and y().

◆ Scissor() [3/3]

osg::Scissor::Scissor ( const Scissor & vp,
const CopyOp & copyop = CopyOp::SHALLOW_COPY )
inline

Copy constructor using CopyOp to manage deep vs shallow copy.

References _height, _width, _x, _y, Scissor(), osg::CopyOp::SHALLOW_COPY, and osg::StateAttribute::StateAttribute().

◆ ~Scissor()

virtual osg::Scissor::~Scissor ( )
protectedvirtual

Member Function Documentation

◆ apply()

virtual void osg::Scissor::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.

◆ compare()

virtual int osg::Scissor::compare ( const StateAttribute & sa) const
inlinevirtual

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

Implements osg::StateAttribute.

References _height, _width, _x, _y, COMPARE_StateAttribute_Parameter, COMPARE_StateAttribute_Types, Scissor(), and osg::StateAttribute::StateAttribute().

◆ getModeUsage()

virtual bool osg::Scissor::getModeUsage ( StateAttribute::ModeUsage & ) const
inlinevirtual

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

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

◆ getScissor()

void osg::Scissor::getScissor ( int & x,
int & y,
int & width,
int & height ) const
inline

References _height, _width, _x, _y, height(), width(), x(), and y().

◆ height() [1/2]

int & osg::Scissor::height ( )
inline

References _height.

Referenced by getScissor(), Scissor(), and setScissor().

◆ height() [2/2]

int osg::Scissor::height ( ) const
inline

References _height.

◆ META_StateAttribute()

osg::Scissor::META_StateAttribute ( osg ,
Scissor ,
SCISSOR  )

References osg::StateAttribute::SCISSOR, and Scissor().

◆ setScissor()

void osg::Scissor::setScissor ( int x,
int y,
int width,
int height )
inline

References _height, _width, _x, _y, height(), width(), x(), and y().

◆ width() [1/2]

int & osg::Scissor::width ( )
inline

References _width.

Referenced by getScissor(), Scissor(), and setScissor().

◆ width() [2/2]

int osg::Scissor::width ( ) const
inline

References _width.

◆ x() [1/2]

int & osg::Scissor::x ( )
inline

References _x.

Referenced by getScissor(), Scissor(), and setScissor().

◆ x() [2/2]

int osg::Scissor::x ( ) const
inline

References _x.

◆ y() [1/2]

int & osg::Scissor::y ( )
inline

References _y.

Referenced by getScissor(), Scissor(), and setScissor().

◆ y() [2/2]

int osg::Scissor::y ( ) const
inline

References _y.

Member Data Documentation

◆ _height

int osg::Scissor::_height
protected

Referenced by compare(), getScissor(), height(), height(), Scissor(), Scissor(), and setScissor().

◆ _width

int osg::Scissor::_width
protected

Referenced by compare(), getScissor(), Scissor(), Scissor(), setScissor(), width(), and width().

◆ _x

int osg::Scissor::_x
protected

Referenced by compare(), getScissor(), Scissor(), Scissor(), setScissor(), x(), and x().

◆ _y

int osg::Scissor::_y
protected

Referenced by compare(), getScissor(), Scissor(), Scissor(), setScissor(), y(), and y().

The documentation for this class was generated from the following file:
Generated by doxygen 1.15.0