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

SoTextureCubeMap Class Reference
[Node Classes]

#include <Inventor/nodes/SoTextureCubeMap.h>

Inherits SoTexture.

List of all members.


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 3.0

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

virtual SoType getTypeId (void) const
 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 SoType getClassTypeId (void)
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 const SoFieldDatagetFieldData (void) const
virtual ~SoTextureCubeMap ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual void notify (SoNotList *list)
int getReadStatus (void)
void setReadStatus (int s)

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)

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   ) 

Constructor.

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

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


Member Function Documentation

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.

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()


Member Data Documentation

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

The pos-x image.

The neg-x image.

The neg-y image.

The neg-y image.

The pos-z image.

The neg-z image.

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

Default value is SoTextureCubeMap::REPEAT.

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

Default value is SoTextureCubeMap::REPEAT.

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

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.


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

Copyright © 1998-2008 by Kongsberg SIM. All rights reserved.

Generated on Sat Nov 8 00:38:24 2008 for Coin by Doxygen 1.5.6.