OpenSceneGraph  3.0.1
Public Member Functions | Protected Member Functions | List of all members
osgFX::BumpMapping Class Reference

This effect makes surfaces appear bumpy. More...

Inheritance diagram for osgFX::BumpMapping:
Inheritance graph
[legend]

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
 get the OpenGL light number
void setLightNumber (int n)
 set the OpenGL light number that will be used in lighting computations
int getDiffuseTextureUnit () const
 get the texture unit that contains diffuse color texture.
void setDiffuseTextureUnit (int n)
 set the texture unit that contains diffuse color texture.
int getNormalMapTextureUnit () const
 get the texture unit that contains normal map texture.
void setNormalMapTextureUnit (int n)
 set the texture unit that contains normal map texture.
osg::Texture2DgetOverrideDiffuseTexture ()
 get the diffuse color texture that overrides children's texture
const osg::Texture2DgetOverrideDiffuseTexture () const
 get the const diffuse color texture that overrides children's texture
void setOverrideDiffuseTexture (osg::Texture2D *texture)
 set the diffuse color texture that overrides children's texture
osg::Texture2DgetOverrideNormalMapTexture ()
 get the normal map texture that overrides children's texture
const osg::Texture2DgetOverrideNormalMapTexture () const
 get the const normal map texture that overrides children's texture
void setOverrideNormalMapTexture (osg::Texture2D *texture)
 set the normal map texture that overrides children's texture
void prepareGeometry (osg::Geometry *geo)
 prepare a Geometry for bump lighting.
void prepareNode (osg::Node *node)
 prepare a Node for bump lighting, calling prepareGeometry() for each Geometry
void prepareChildren ()
 prepare children for bump lighting.
void setUpDemo ()
 set up a demo environment with predefined diffuse and normal maps, as well as texture coordinates
- 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
 return true if this and obj are of the same kind of object.
virtual const char * libraryName () const
 return the name of the node's library.
virtual const char * className () const
 return the name of the node's class type.
virtual const char * effectName () const =0
 get the name of this Effect
virtual const char * effectDescription () const =0
 get a brief description of this Effect
virtual const char * effectAuthor () const =0
 get the effect author's name
bool getEnabled () const
 get whether the effect is enabled or not
void setEnabled (bool v)
 set whether the effect is enabled or not
int getNumTechniques () const
 get the number of techniques defined for this Effect
TechniquegetTechnique (int i)
 get the i-th Technique
const TechniquegetTechnique (int i) const
 get the i-th const Technique
int getSelectedTechnique () const
 get the index of the currently selected Technique
void selectTechnique (int i=AUTO_DETECT)
 select a technique or enable automatic detection
virtual void traverse (osg::NodeVisitor &nv)
 custom traversal
void inherited_traverse (osg::NodeVisitor &nv)
 default traversal
- Public Member Functions inherited from osg::Group
 Group ()
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
 META_Node (osg, Group)
virtual GroupasGroup ()
 convert 'this' into a Group pointer if Node is a Group, otherwise return 0.
virtual const GroupasGroup () const
 convert 'const this' into a const Group pointer if Node is a Group, otherwise return 0.
virtual bool addChild (Node *child)
 Add Node to Group.
virtual bool insertChild (unsigned int index, Node *child)
 Insert Node to Group at specific location.
bool removeChild (Node *child)
 Remove Node from Group.
bool removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
 Remove Node from Group.
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
 Remove children from Group.
virtual bool replaceChild (Node *origChild, Node *newChild)
 Replace specified Node with another Node.
unsigned int getNumChildren () const
 Return the number of children nodes.
virtual bool setChild (unsigned int i, Node *node)
 Set child node at position i.
NodegetChild (unsigned int i)
 Return child node at position i.
const NodegetChild (unsigned int i) const
 Return child node at position i.
bool containsNode (const Node *node) const
 Return true if node is contained within Group.
unsigned int getChildIndex (const Node *node) const
 Get the index number of child, return a value between 0 and _children.size()-1 if found, if not found then return _children.size().
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size.
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
virtual BoundingSphere computeBound () const
 Compute the bounding sphere around Node's geometry or children.
- Public Member Functions inherited from osg::Node
 Node ()
 Construct a node.
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
virtual ObjectcloneType () const
 clone an object of the same type as the node.
virtual Objectclone (const CopyOp &copyop) const
 return a clone of a node, with Object* return type.
virtual TransformasTransform ()
 Convert 'this' into a Transform pointer if Node is a Transform, otherwise return 0.
virtual const TransformasTransform () const
 convert 'const this' into a const Transform pointer if Node is a Transform, otherwise return 0.
virtual SwitchasSwitch ()
 Convert 'this' into a Switch pointer if Node is a Switch, otherwise return 0.
virtual const SwitchasSwitch () const
 convert 'const this' into a const Switch pointer if Node is a Switch, otherwise return 0.
virtual GeodeasGeode ()
 Convert 'this' into a Geode pointer if Node is a Geode, otherwise return 0.
virtual const GeodeasGeode () const
 convert 'const this' into a const Geode pointer if Node is a Geode, otherwise return 0.
virtual osgTerrain::TerrainasTerrain ()
 Convert 'this' into a Transform pointer if Node is a Terrain, otherwise return 0.
virtual const osgTerrain::TerrainasTerrain () const
 convert 'const this' into a const Terrain pointer if Node is a Terrain, otherwise return 0.
virtual void accept (NodeVisitor &nv)
 Visitor Pattern : calls the apply method of a NodeVisitor with this node's type.
virtual void ascend (NodeVisitor &nv)
 Traverse upwards : calls parents' accept method with NodeVisitor.
const ParentListgetParents () const
 Get the parent list of node.
ParentList getParents ()
 Get the a copy of parent list of node.
GroupgetParent (unsigned int i)
const GroupgetParent (unsigned int i) const
 Get a single const parent of node.
unsigned int getNumParents () const
 Get the number of parents of node.
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
 Get the list of node paths parent paths.
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
 Get the list of matrices that transform this node from local coordinates to world coordinates.
void setUpdateCallback (NodeCallback *nc)
 Set update node callback, called during update traversal.
NodeCallbackgetUpdateCallback ()
 Get update node callback, called during update traversal.
const NodeCallbackgetUpdateCallback () const
 Get const update node callback, called during update traversal.
void addUpdateCallback (NodeCallback *nc)
 Convenience method that sets the update callback of the node if it doesn't exist, or nest it into the existing one.
void removeUpdateCallback (NodeCallback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested.
unsigned int getNumChildrenRequiringUpdateTraversal () const
 Get the number of Children of this node which require Update traversal, since they have an Update Callback attached to them or their children.
void setEventCallback (NodeCallback *nc)
 Set event node callback, called during event traversal.
NodeCallbackgetEventCallback ()
 Get event node callback, called during event traversal.
const NodeCallbackgetEventCallback () const
 Get const event node callback, called during event traversal.
void addEventCallback (NodeCallback *nc)
 Convenience method that sets the event callback of the node if it doesn't exist, or nest it into the existing one.
void removeEventCallback (NodeCallback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested.
unsigned int getNumChildrenRequiringEventTraversal () const
 Get the number of Children of this node which require Event traversal, since they have an Event Callback attached to them or their children.
void setCullCallback (NodeCallback *nc)
 Set cull node callback, called during cull traversal.
NodeCallbackgetCullCallback ()
 Get cull node callback, called during cull traversal.
const NodeCallbackgetCullCallback () const
 Get const cull node callback, called during cull traversal.
void addCullCallback (NodeCallback *nc)
 Convenience method that sets the cull callback of the node if it doesn't exist, or nest it into the existing one.
void removeCullCallback (NodeCallback *nc)
 Convenience method that removes a given callback from a node, even if that callback is nested.
void setCullingActive (bool active)
 Set the view frustum/small feature culling of this node to be active or inactive.
bool getCullingActive () const
 Get the view frustum/small feature _cullingActive flag for this node.
unsigned int getNumChildrenWithCullingDisabled () const
 Get the number of Children of this node which have culling disabled.
bool isCullingActive () const
 Return true if this node can be culled by view frustum, occlusion or small feature culling during the cull traversal.
unsigned int getNumChildrenWithOccluderNodes () const
 Get the number of Children of this node which are or have OccluderNode's.
bool containsOccluderNodes () const
 return true if this node is an OccluderNode or the subgraph below this node are OccluderNodes.
void setNodeMask (NodeMask nm)
 Set the node mask.
NodeMask getNodeMask () const
 Get the node Mask.
void setStateSet (osg::StateSet *stateset)
 Set the node's StateSet.
osg::StateSetgetOrCreateStateSet ()
 return the node's StateSet, if one does not already exist create it set the node and return the newly created StateSet.
osg::StateSetgetStateSet ()
 Return the node's StateSet.
const osg::StateSetgetStateSet () const
 Return the node's const StateSet.
void setDescriptions (const DescriptionList &descriptions)
 Set the list of string descriptions.
DescriptionListgetDescriptions ()
 Get the description list of the node.
const DescriptionListgetDescriptions () const
 Get the const description list of the const node.
const std::string & getDescription (unsigned int i) const
 Get a single const description of the const node.
std::string & getDescription (unsigned int i)
 Get a single description of the node.
unsigned int getNumDescriptions () const
 Get the number of descriptions of the node.
void addDescription (const std::string &desc)
 Add a description string to the node.
void setInitialBound (const osg::BoundingSphere &bsphere)
 Set the initial bounding volume to use when computing the overall bounding volume.
const BoundingSpheregetInitialBound () const
 Set the initial bounding volume to use when computing the overall bounding volume.
void dirtyBound ()
 Mark this node's bounding sphere dirty.
const BoundingSpheregetBound () const
 Get the bounding sphere of node.
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
 Set the compute bound callback to override the default computeBound.
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 Get the compute bound callback.
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () const
 Get the const compute bound callback.
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object.
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convinience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convinience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convinience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Protected Member Functions

virtual ~BumpMapping ()
BumpMappingoperator= (const BumpMapping &)
bool define_techniques ()
 abstract method to be implemented in derived classes; its purpose if to create the techniques that can be used for obtaining the desired effect.
- Protected Member Functions inherited from osgFX::Effect
virtual ~Effect ()
Effectoperator= (const Effect &)
void dirtyTechniques ()
 force rebuilding of techniques on next traversal
void addTechnique (Technique *tech)
 add a technique to the Effect
- 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 ()
 Node destructor.
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 ()
 Object destructor.
- 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::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced.
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting.
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active.
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler.
- 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:

osg logo
Generated at Tue Sep 4 2012 16:27:10 for the OpenSceneGraph by doxygen 1.8.1.2.