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

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

SoSceneTexture2 Class Reference
[Nodes]

#include <Inventor/nodes/SoSceneTexture2.h>

Inheritance diagram for SoSceneTexture2:

SoNode SoFieldContainer SoBase List of all members.

Detailed Description

The SoSceneTexture2 class is used to create a 2D texture from a Coin scene graph.

This node behaves exactly like SoTexture2 when it comes mapping the actual texture onto subsequent geometry. Please read the SoTexture2 documentation for more information about how textures are mapped onto shapes.

Since:
Coin 2.2


Public Types

enum  Model { MODULATE = SoTextureImageElement::MODULATE, DECAL = SoTextureImageElement::DECAL, BLEND = SoTextureImageElement::BLEND, REPLACE = SoTextureImageElement::REPLACE }
enum  Wrap { REPEAT = SoTextureImageElement::REPEAT, CLAMP = SoTextureImageElement::CLAMP }
enum  TransparencyFunction { NONE, ALPHA_BLEND, ALPHA_TEST }

Public Member Functions

virtual SoType getTypeId (void) const
virtual void notify (SoNotList *list)
virtual void write (SoWriteAction *action)
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void rayPick (SoRayPickAction *action)

Static Public Member Functions

SoType getClassTypeId (void)
void initClass (void)

Public Attributes

SoSFEnum wrapS
SoSFEnum wrapT
SoSFEnum model
SoSFColor blendColor
SoSFVec4f backgroundColor
SoSFVec2s size
SoSFNode scene
SoSFEnum transparencyFunction

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const

Static Protected Member Functions

const SoFieldData ** getFieldDataPtr (void)


Member Enumeration Documentation

enum SoSceneTexture2::Model
 

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

Enumeration values:
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 SoSceneTexture2::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.

Since:
Coin 2.2

TGS Inventor 4.0

enum SoSceneTexture2::Wrap
 

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

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

enum SoSceneTexture2::TransparencyFunction
 

For deciding how the texture's alpha channel is handled. It's not possible to automatically detect this, since the texture is stored only on the graphics card's memory, and it'd be too slow to fetch the image to test the alpha channel like Coin does for regular textures.

Enumeration values:
NONE  The alpha channel is ignored.
ALPHA_BLEND  Alpha blending is used.
ALPHA_TEST  An alpha test function is used.


Member Function Documentation

SoType SoSceneTexture2::getClassTypeId void   )  [static]
 

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoNode.

SoType SoSceneTexture2::getTypeId void   )  const [virtual]
 

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.

Usage example:

void foo(SoNode * node) { if (node->getTypeId() == SoFile::getClassTypeId()) { SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type } else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) { SoGroup * group = (SoGroup *)node; // safe downward cast, knows the type } }

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

const SoFieldData ** SoSceneTexture2::getFieldDataPtr void   )  [static, protected]
 

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Reimplemented from SoNode.

const SoFieldData * SoSceneTexture2::getFieldData void   )  const [protected, virtual]
 

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoFieldContainer.

void SoSceneTexture2::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 SoSceneTexture2::notify SoNotList list  )  [virtual]
 

Notifies all auditors for this instance when changes are made.

Reimplemented from SoNode.

void SoSceneTexture2::write SoWriteAction action  )  [virtual]
 

Action method for SoWriteAction.

Writes out a node object, and any connected nodes, engines etc, if necessary.

Reimplemented from SoNode.

void SoSceneTexture2::doAction SoAction action  )  [virtual]
 

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

Reimplemented from SoNode.

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

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


Member Data Documentation

SoSFEnum SoSceneTexture2::wrapS
 

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

Default value is SoSceneTexture2::REPEAT.

SoSFEnum SoSceneTexture2::wrapT
 

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

Default value is SoSceneTexture2::REPEAT.

SoSFEnum SoSceneTexture2::model
 

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

SoSFColor SoSceneTexture2::blendColor
 

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

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

SoSFVec4f SoSceneTexture2::backgroundColor
 

The color the color buffer is cleared to before rendering the scene. Default value is (0.0f, 0.0f, 0.0f, 0.0f).

SoSFVec2s SoSceneTexture2::size
 

The size of the texture. This node currently only supports power of two textures. If the size is not a power of two, the value will be rounded upwards to the next power of two.

SoSFNode SoSceneTexture2::scene
 

The scene graph that is rendered into the texture.

SoSFEnum SoSceneTexture2::transparencyFunction
 

The transparency function used. Default value is NONE.


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

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

Generated on Sat Apr 10 08:33:55 2004 for Coin by Doxygen. 1.3.6-20040222