openscenegraph
Public Member Functions | Protected Member Functions | List of all members
osgFX::Outline Class Reference
Inheritance diagram for osgFX::Outline:
osgFX::Effect osg::Group osg::Node osg::Object osg::Referenced

Public Member Functions

 Outline ()
 Constructor.
 Outline (const Outline &copy, const osg::CopyOp &op=osg::CopyOp::SHALLOW_COPY)
 Copy constructor.
 META_Effect (osgFX, Outline,"Outline","Stencil buffer based object outline effect.\n""This effect needs a properly setup stencil buffer.","Ulrich Hertlein")
void setWidth (float w)
 Set outline width.
float getWidth () const
 Get outline width.
void setColor (const osg::Vec4 &color)
 Set outline color.
const osg::Vec4getColor () const
 Get outline color.
- Public Member Functions inherited from osgFX::Effect
 Effect ()
 Effect (const Effect &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
virtual bool isSameKindAs (const osg::Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual const char * effectName () const =0
virtual const char * effectDescription () const =0
virtual const char * effectAuthor () const =0
bool getEnabled () const
void setEnabled (bool v)
virtual void setUpDemo ()
int getNumTechniques () const
TechniquegetTechnique (int i)
const TechniquegetTechnique (int i) const
int getSelectedTechnique () const
void selectTechnique (int i=AUTO_DETECT)
virtual void traverse (osg::NodeVisitor &nv)
void inherited_traverse (osg::NodeVisitor &nv)
- Public Member Functions inherited from osg::Group
 Group ()
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, Group)
virtual GroupasGroup ()
virtual const GroupasGroup () const
virtual bool addChild (Node *child)
virtual bool insertChild (unsigned int index, Node *child)
bool removeChild (Node *child)
bool removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
virtual bool replaceChild (Node *origChild, Node *newChild)
unsigned int getNumChildren () const
virtual bool setChild (unsigned int i, Node *node)
NodegetChild (unsigned int i)
const NodegetChild (unsigned int i) const
bool containsNode (const Node *node) const
unsigned int getChildIndex (const Node *node) const
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void resizeGLObjectBuffers (unsigned int maxSize)
virtual void releaseGLObjects (osg::State *=0) const
virtual BoundingSphere computeBound () const
- Public Member Functions inherited from osg::Node
 Node ()
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const
virtual Objectclone (const CopyOp &copyop) const
virtual TransformasTransform ()
virtual const TransformasTransform () const
virtual SwitchasSwitch ()
virtual const SwitchasSwitch () const
virtual GeodeasGeode ()
virtual const GeodeasGeode () const
virtual osgTerrain::TerrainasTerrain ()
virtual const osgTerrain::TerrainasTerrain () const
virtual void accept (NodeVisitor &nv)
virtual void ascend (NodeVisitor &nv)
const ParentListgetParents () const
ParentList getParents ()
GroupgetParent (unsigned int i)
const GroupgetParent (unsigned int i) const
unsigned int getNumParents () const
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void setUpdateCallback (NodeCallback *nc)
NodeCallbackgetUpdateCallback ()
const NodeCallbackgetUpdateCallback () const
void addUpdateCallback (NodeCallback *nc)
void removeUpdateCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringUpdateTraversal () const
void setEventCallback (NodeCallback *nc)
NodeCallbackgetEventCallback ()
const NodeCallbackgetEventCallback () const
void addEventCallback (NodeCallback *nc)
void removeEventCallback (NodeCallback *nc)
unsigned int getNumChildrenRequiringEventTraversal () const
void setCullCallback (NodeCallback *nc)
NodeCallbackgetCullCallback ()
const NodeCallbackgetCullCallback () const
void addCullCallback (NodeCallback *nc)
void removeCullCallback (NodeCallback *nc)
void setCullingActive (bool active)
bool getCullingActive () const
unsigned int getNumChildrenWithCullingDisabled () const
bool isCullingActive () const
unsigned int getNumChildrenWithOccluderNodes () const
bool containsOccluderNodes () const
void setNodeMask (NodeMask nm)
NodeMask getNodeMask () const
void setStateSet (osg::StateSet *stateset)
osg::StateSetgetOrCreateStateSet ()
osg::StateSetgetStateSet ()
const osg::StateSetgetStateSet () const
void setDescriptions (const DescriptionList &descriptions)
DescriptionListgetDescriptions ()
const DescriptionListgetDescriptions () const
const std::string & getDescription (unsigned int i) const
std::string & getDescription (unsigned int i)
unsigned int getNumDescriptions () const
void addDescription (const std::string &desc)
void setInitialBound (const osg::BoundingSphere &bsphere)
const BoundingSpheregetInitialBound () const
void dirtyBound ()
const BoundingSpheregetBound () const
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () const
- Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
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)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () 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)
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const

Protected Member Functions

virtual ~Outline ()
 Destructor.
bool define_techniques ()
 Define available techniques.
- Protected Member Functions inherited from osgFX::Effect
virtual ~Effect ()
Effectoperator= (const Effect &)
void dirtyTechniques ()
void addTechnique (Technique *tech)
- Protected Member Functions inherited from osg::Group
virtual ~Group ()
virtual void childRemoved (unsigned int, unsigned int)
virtual void childInserted (unsigned int)
- Protected Member Functions inherited from osg::Node
virtual ~Node ()
void addParent (osg::Group *node)
void removeParent (osg::Group *node)
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
void setNumChildrenRequiringEventTraversal (unsigned int num)
void setNumChildrenWithCullingDisabled (unsigned int num)
void setNumChildrenWithOccluderNodes (unsigned int num)
- 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

Additional Inherited Members

- Public Types inherited from osgFX::Effect
enum  TechniqueSelection { AUTO_DETECT = -1 }
- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()
- Protected Attributes inherited from osg::Group
NodeList _children

Detailed Description

Outline effect. This effect draws a stencil buffer-based outline around an object. Color and width of the outline can be modified. To function correctly the context must be setup with a stencil buffer and the stencil buffer must be cleared to zero before each render.

osg::DisplaySettings::instance()->setMinimumNumStencilBits(1); camera->setClearMask(clearMask | GL_STENCIL_BUFFER_BIT); camera->setClearStencil(0);

Constructor & Destructor Documentation

osgFX::Outline::Outline ( )

Constructor.

osgFX::Outline::Outline ( const Outline copy,
const osg::CopyOp op = osg::CopyOp::SHALLOW_COPY 
)
inline

Copy constructor.

virtual osgFX::Outline::~Outline ( )
inlineprotectedvirtual

Destructor.

Member Function Documentation

bool osgFX::Outline::define_techniques ( )
protectedvirtual

Define available techniques.

Implements osgFX::Effect.

const osg::Vec4& osgFX::Outline::getColor ( ) const
inline

Get outline color.

float osgFX::Outline::getWidth ( ) const
inline

Get outline width.

osgFX::Outline::META_Effect ( osgFX  ,
Outline  ,
"Outline"  ,
"Stencil buffer based object outline effect.\n""This effect needs a properly setup stencil buffer."  ,
"Ulrich Hertlein"   
)
void osgFX::Outline::setColor ( const osg::Vec4 color)

Set outline color.

void osgFX::Outline::setWidth ( float  w)

Set outline width.


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