Coin Logo http://www.sim.no
http://www.coin3d.org

Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions

SoTextureCubeMap Class Reference

The SoTextureCubeMap class is used to map a cube map onto subsequent shape nodes.Shape nodes within the scope of SoTextureCubeMap nodes in the scenegraph (ie below the same SoSeparator and to the righthand side of the SoTextureCubeMap) 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. More...

#include <Inventor/nodes/SoTextureCubeMap.h>

Inheritance diagram for SoTextureCubeMap:
SoNode SoFieldContainer SoBase

List of all members.

Public Types

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

Public Member Functions

 SoTextureCubeMap (void)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void rayPick (SoRayPickAction *action)

Static Public Member Functions

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

Public Attributes

SoMFString filenames
SoSFImage imagePosX
SoSFImage imageNegX
SoSFImage imagePosY
SoSFImage imageNegY
SoSFImage imagePosZ
SoSFImage imageNegZ
SoSFEnum wrapS
SoSFEnum wrapT
SoSFEnum model
SoSFColor blendColor

Protected Member Functions

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

Detailed Description

The SoTextureCubeMap class is used to map a cube map onto subsequent shape nodes.

Shape nodes within the scope of SoTextureCubeMap nodes in the scenegraph (ie below the same SoSeparator and to the righthand side of the SoTextureCubeMap) 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.

FILE FORMAT/DEFAULTS:

    TextureCubeMap {
        filenames [  ]
        imagePosX 0 0 0
        imageNegX 0 0 0
        imagePosY 0 0 0
        imageNegY 0 0 0
        imagePosZ 0 0 0
        imageNegZ 0 0 0
        wrapS REPEAT
        wrapT REPEAT
        model MODULATE
        blendColor 0 0 0
    }
Since:
Coin 2.5

Member Enumeration Documentation

Texture mapping model, for deciding how to "merge" the texturemap with the object it is mapped onto.

Enumerator:
MODULATE 

Texture color is multiplied by the polygon color. The result will be Phong shaded (if light model is PHONG).

DECAL 

Texture image overwrites polygon shading. Textured pixels will not be Phong shaded. Has undefined behaviour for grayscale and grayscale-alpha textures.

BLEND 

This model is normally used with monochrome textures (i.e. textures with one or two components). The first component, the intensity, is then used to blend between the shaded color of the polygon and the SoTextureCubeMap::blendColor.

REPLACE 

Texture image overwrites polygon shading. Textured pixels will not be Phong shaded. Supports grayscale and grayscale alpha textures. This feature requires OpenGL 1.1. MODULATE will be used if OpenGL version < 1.1 is detected.

Please note that using this texture model will make your Inventor files incompatible with older versions of Coin and Inventor. You need Coin >= 2.2 or TGS Inventor 4.0 to load Inventor files that uses the REPLACE texture model.

Enumeration of wrapping strategies which can be used when the texturemap doesn't cover the full extent of the geometry.

Enumerator:
REPEAT 

Repeat texture when coordinate is not between 0 and 1.

CLAMP 

Clamp coordinate between 0 and 1.


Constructor & Destructor Documentation

SoTextureCubeMap::SoTextureCubeMap ( void  )
SoTextureCubeMap::~SoTextureCubeMap ( ) [protected, virtual]

Destructor. Frees up internal resources used to store texture image data.


Member Function Documentation

void SoTextureCubeMap::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 SoTextureCubeMap::doAction ( SoAction action) [virtual]

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

Reimplemented from SoNode.

References blendColor, SoAction::getState(), SbVec2s::getValue(), SoNode::isOverride(), model, SoFieldContainer::set(), wrapS, and wrapT.

Referenced by callback(), and rayPick().

void SoTextureCubeMap::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.

References blendColor, SoFieldContainer::get(), SoAction::getState(), SoSFImage::getValue(), SoState::isCacheOpen(), SoNode::isOverride(), model, MODULATE, SoDebugError::postWarning(), and SoFieldContainer::set().

void SoTextureCubeMap::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.

References doAction().

void SoTextureCubeMap::rayPick ( SoRayPickAction action) [virtual]

Action method for SoRayPickAction.

Checks the ray specification of the action and tests for intersection with the data of the node.

Nodes influencing relevant state variables for how picking is done also overrides this method.

Reimplemented from SoNode.

References doAction().

SbBool SoTextureCubeMap::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 original SGI Open Inventor API. We'll consider to implement it if requested.

SbBool SoTextureCubeMap::readInstance ( SoInput in,
unsigned short  flags 
) [protected, virtual]

This method is mainly intended for internal use during file import operations.

It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistant representation of an instance of this class type.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. The import process should be robust and handle corrupted input streams by returning FALSE.

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

Reimplemented from SoNode.

References filenames, SbString::getLength(), SoMField::getNum(), SbString::getString(), imageNegX, imageNegY, imageNegZ, imagePosX, imagePosY, imagePosZ, SoField::isDefault(), SoReadError::post(), SoNode::readInstance(), and setReadStatus().

void SoTextureCubeMap::notify ( SoNotList l) [protected, virtual]

Notifies all auditors for this instance when changes are made.

Reimplemented from SoNode.

References SoNotList::getLastField(), imageNegX, imageNegY, imageNegZ, imagePosX, imagePosY, imagePosZ, SoNode::notify(), SoField::setDefault(), wrapS, and wrapT.

int SoTextureCubeMap::getReadStatus ( void  ) [protected]

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

void SoTextureCubeMap::setReadStatus ( int  s) [protected]

Sets read status.

See also:
getReadStatus()

Referenced by readInstance().


Member Data Documentation

The filenames in this order: negx, posx, negy, posy, negz, posz.

Referenced by readInstance(), and SoTextureCubeMap().

The pos-x image.

Referenced by notify(), readInstance(), and SoTextureCubeMap().

The neg-x image.

Referenced by notify(), readInstance(), and SoTextureCubeMap().

The neg-y image.

Referenced by notify(), readInstance(), and SoTextureCubeMap().

The neg-y image.

Referenced by notify(), readInstance(), and SoTextureCubeMap().

The pos-z image.

Referenced by notify(), readInstance(), and SoTextureCubeMap().

The neg-z image.

Referenced by notify(), readInstance(), and SoTextureCubeMap().

Wrapping strategy for the S coordinate when the texturemap is narrower than the object to map onto.

Default value is SoTextureCubeMap::REPEAT.

Referenced by doAction(), notify(), and SoTextureCubeMap().

Wrapping strategy for the T coordinate when the texturemap is shorter than the object to map onto.

Default value is SoTextureCubeMap::REPEAT.

Referenced by doAction(), notify(), and SoTextureCubeMap().

Texturemapping model for how the texturemap is "merged" with the polygon primitives it is applied to. Default value is SoTextureCubeMap::MODULATE.

Referenced by doAction(), GLRender(), and SoTextureCubeMap().

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

Default color value is [0, 0, 0], black, which means no contribution to the blending is made.

Referenced by doAction(), GLRender(), and SoTextureCubeMap().


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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 28 2011 10:12:22 for Coin by Doxygen. 1.7.3