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

Public Member Functions

 BumpMapping ()
 BumpMapping (const BumpMapping &copy, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 META_Effect (osgFX, BumpMapping,"Bump Mapping","This effect makes surfaces appear bumpy. Children nodes must use two textures, ""one for diffuse color and one for the normal map (which can be created ""from a height map with tools like nVIDIA's normal map generator). Furthermore, ""tangent-space basis vectors must be created and assigned to each Geometry; this ""can be done quickly by calling BumpMapping::prepareChildren(). Note that both ""diffuse and normal map textures must have corresponding UV maps defined in ""Geometry objects.\n""This effect defines a preferred technique which uses ARB vertex & fragment ""programs, and a fallback technique which doesn't use fragment programs. The ""latter is more limited though since it can't handle ambient and specular ""components.","Marco Jez")
int getLightNumber () const
void setLightNumber (int n)
int getDiffuseTextureUnit () const
void setDiffuseTextureUnit (int n)
int getNormalMapTextureUnit () const
void setNormalMapTextureUnit (int n)
osg::Texture2DgetOverrideDiffuseTexture ()
const osg::Texture2DgetOverrideDiffuseTexture () const
void setOverrideDiffuseTexture (osg::Texture2D *texture)
osg::Texture2DgetOverrideNormalMapTexture ()
const osg::Texture2DgetOverrideNormalMapTexture () const
void setOverrideNormalMapTexture (osg::Texture2D *texture)
void prepareGeometry (osg::Geometry *geo)
void prepareNode (osg::Node *node)
void prepareChildren ()
void setUpDemo ()
- 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)
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 ~BumpMapping ()
BumpMappingoperator= (const BumpMapping &)
bool define_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

This effect makes surfaces appear bumpy. Children nodes must use two textures, one for diffuse color and one for the normal map (which can be created from a height map with tools like nVIDIA's normal map generator). Furthermore, tangent-space basis vectors must be created and assigned to each Geometry; this can be done quickly by calling BumpMapping::prepareChildren(). Note that both diffuse and normal map textures must have corresponding UV maps defined in Geometry objects. This effect defines a preferred technique which uses ARB vertex & fragment programs, and a fallback technique which doesn't use fragment programs. The latter is more limited though since it can't handle ambient and specular components.

Constructor & Destructor Documentation

osgFX::BumpMapping::BumpMapping ( )
osgFX::BumpMapping::BumpMapping ( const BumpMapping copy,
const osg::CopyOp copyop = osg::CopyOp::SHALLOW_COPY 
)
virtual osgFX::BumpMapping::~BumpMapping ( )
inlineprotectedvirtual

Member Function Documentation

bool osgFX::BumpMapping::define_techniques ( )
protectedvirtual

abstract method to be implemented in derived classes; its purpose if to create the techniques that can be used for obtaining the desired effect. You will usually call addTechnique() inside this method.

Implements osgFX::Effect.

int osgFX::BumpMapping::getDiffuseTextureUnit ( ) const
inline

get the texture unit that contains diffuse color texture. Default is 1

int osgFX::BumpMapping::getLightNumber ( ) const
inline

get the OpenGL light number

int osgFX::BumpMapping::getNormalMapTextureUnit ( ) const
inline

get the texture unit that contains normal map texture. Default is 0

osg::Texture2D * osgFX::BumpMapping::getOverrideDiffuseTexture ( )
inline

get the diffuse color texture that overrides children's texture

References osg::ref_ptr< T >::get().

const osg::Texture2D * osgFX::BumpMapping::getOverrideDiffuseTexture ( ) const
inline

get the const diffuse color texture that overrides children's texture

References osg::ref_ptr< T >::get().

osg::Texture2D * osgFX::BumpMapping::getOverrideNormalMapTexture ( )
inline

get the normal map texture that overrides children's texture

References osg::ref_ptr< T >::get().

const osg::Texture2D * osgFX::BumpMapping::getOverrideNormalMapTexture ( ) const
inline

get the const normal map texture that overrides children's texture

References osg::ref_ptr< T >::get().

osgFX::BumpMapping::META_Effect ( osgFX  ,
BumpMapping  ,
"Bump Mapping"  ,
"This effect makes surfaces appear bumpy. Children nodes must use two  textures,
""one for diffuse color and one for the normal map(which can be created""from a height map with tools like nVIDIA's normal map generator).  Furthermore,
""tangent-space basis vectors must be created and assigned to each Geometry;this""can be done quickly by calling BumpMapping::prepareChildren().Note that both""diffuse and normal map textures must have corresponding UV maps defined in""Geometry objects.\n""This effect defines a preferred technique which uses ARB vertex &fragment""  programs,
and a fallback technique which doesn't use fragment programs.The""latter is more limited though since it can't handle ambient and specular""components."  ,
"Marco Jez"   
)
BumpMapping& osgFX::BumpMapping::operator= ( const BumpMapping )
inlineprotected
void osgFX::BumpMapping::prepareChildren ( )

prepare children for bump lighting. Actually calls prepareNode() for each child

void osgFX::BumpMapping::prepareGeometry ( osg::Geometry geo)

prepare a Geometry for bump lighting. Tangent-space basis vectors are generated and attached to the geometry as vertex attribute arrays.

void osgFX::BumpMapping::prepareNode ( osg::Node node)

prepare a Node for bump lighting, calling prepareGeometry() for each Geometry

void osgFX::BumpMapping::setDiffuseTextureUnit ( int  n)
inline

set the texture unit that contains diffuse color texture. Default is 1

References osgFX::Effect::dirtyTechniques().

void osgFX::BumpMapping::setLightNumber ( int  n)
inline

set the OpenGL light number that will be used in lighting computations

References osgFX::Effect::dirtyTechniques().

void osgFX::BumpMapping::setNormalMapTextureUnit ( int  n)
inline

set the texture unit that contains normal map texture. Default is 0

References osgFX::Effect::dirtyTechniques().

void osgFX::BumpMapping::setOverrideDiffuseTexture ( osg::Texture2D texture)
inline

set the diffuse color texture that overrides children's texture

References osgFX::Effect::dirtyTechniques().

void osgFX::BumpMapping::setOverrideNormalMapTexture ( osg::Texture2D texture)
inline

set the normal map texture that overrides children's texture

References osgFX::Effect::dirtyTechniques().

void osgFX::BumpMapping::setUpDemo ( )
virtual

set up a demo environment with predefined diffuse and normal maps, as well as texture coordinates

Reimplemented from osgFX::Effect.


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