Main Page   Modules   Class Hierarchy   Compound List   File List   Compound Members  

SoTexture2 Class Reference

The SoTexture2 class is used to map a 2D texture onto geometry. More...

#include <Inventor/nodes/SoTexture2.h>

Inheritance diagram for SoTexture2::

SoNode SoFieldContainer SoBase List of all members.

Public Types

enum  Model { MODULATE = SoTextureImageElement::MODULATE, DECAL = SoTextureImageElement::DECAL, BLEND = SoTextureImageElement::BLEND }
enum  Wrap { REPEAT = SoTextureImageElement::REPEAT, CLAMP = SoTextureImageElement::CLAMP }

Public Methods

 SoTexture2 (void)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)

Static Public Methods

void initClass (void)
SbBool readImage (const SbString &fname, int &w, int &h, int &nc, unsigned char *&bytes)

Public Attributes

SoSFString filename
SoSFImage image
SoSFEnum wrapS
SoSFEnum wrapT
SoSFEnum model
SoSFColor blendColor

Protected Methods

virtual ~SoTexture2 ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual void notify (SoNotList *list)
int getReadStatus (void)
void setReadStatus (int s)

Detailed Description

The SoTexture2 class is used to map a 2D texture onto geometry.

Shape nodes within the scope of SoTexture2 nodes in the scenegraph (ie below the same SoSeparator and to the righthand side of the SoTexture2) will have the texture applied according to each shape type's individual characteristics. See the documentation of the various shape types (SoFaceSet, SoCube, SoSphere, etc etc) for information about the specifics of how the textures will be applied.


Member Enumeration Documentation

enum SoTexture2::Model
 

Texture mapping model.

Enumeration values:
MODULATE  Texture image is modulated with polygon.
DECAL  Texture image overwrites polygon color.
BLEND  Blend image using blendColor.

enum SoTexture2::Wrap
 

Enum used to specify wrapping strategy.

Enumeration values:
REPEAT  Repeat texture when coordinate is not between 0 and 1.
CLAMP  Clamp coordinate between 0 and 1.


Constructor & Destructor Documentation

SoTexture2::SoTexture2 void   
 

Constructor.

SoTexture2::~SoTexture2   [protected, virtual]
 

Destructor.


Member Function Documentation

void SoTexture2::initClass void    [static]
 

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoNode.

void SoTexture2::doAction SoAction   action [virtual]
 

This function performs the typical operation of a node for any action.

Reimplemented from SoNode.

void SoTexture2::GLRender SoGLRenderAction   action [virtual]
 

Action method for the SoGLRenderAction.

This is called during rendering traversals. Nodes influencing the rendering state in any way or who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoNode.

void SoTexture2::callback SoCallbackAction   action [virtual]
 

Action method for SoCallbackAction.

Simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph.

Reimplemented from SoNode.

SbBool SoTexture2::readImage const SbString   fname,
int &    w,
int &    h,
int &    nc,
unsigned char *&    bytes
[static]
 

Not implemented in Coin; should probably not have been public in the Open Inventor API. We'll consider to implement it if requested.

SbBool SoTexture2::readInstance SoInput   in,
unsigned short    flags
[protected, virtual]
 

Overloaded to check if texture file (if any) can be found and loaded.

Reimplemented from SoNode.

void SoTexture2::notify SoNotList   list [protected, virtual]
 

Overloaded to detect when fields change.

Reimplemented from SoNode.

int SoTexture2::getReadStatus void    [protected]
 

Returns read status. 1 for success, 0 for failure.

void SoTexture2::setReadStatus int    s [protected]
 

Sets read status.

See also:
getReadStatus()


Member Data Documentation

SoSFString SoTexture2::filename
 

Texture filename. Specify either this or use SoTexture2::image, not both.

SoSFImage SoTexture2::image
 

Inline image data.

SoSFEnum SoTexture2::wrapS
 

Wrapping strategy for the S coordinate.

SoSFEnum SoTexture2::wrapT
 

Wrapping strategy for the T coordinate.

SoSFEnum SoTexture2::model
 

Texture model.

SoSFColor SoTexture2::blendColor
 

Blend color. Used when SoTexture2::model is SoTexture2::BLEND.


The documentation for this class was generated from the following files:
Generated on Sat Jan 12 11:41:19 2002 for Coin by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001