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

SoTextureCombine Class Reference
[Nodes]

#include <Inventor/nodes/SoTextureCombine.h>

Inheritance diagram for SoTextureCombine:

SoNode SoFieldContainer SoBase List of all members.

Detailed Description

The SoTextureCombine class is a node for setting texture combine functions.

This node is more or less an exact mapping of the OpenGL ARB_texture_env_combine extension (included in OpenGL in OpenGL v1.3). See http://oss.sgi.com/projects/ogl-sample/registry/ARB/texture_env_combine.txt for more information about this extension.

Basically this node lets you specify up to three sources, and a function to combine those sources. In addition to the function, it's possible to apply simple operands on the sources. In the documentation below, the sources will be called Arg0, Arg1, and Arg2, just like in the ARB_texture_env_mode specification.

It's possible to specify both a color and an alpha operation.

This node has many fields, but usually it is sufficient to set only one or very few fields. FIXME: more doc, pederb, 2004-01-27

Since:
Coin 2.3


Public Types

enum  Source { PRIMARY_COLOR = SoTextureCombineElement::PRIMARY_COLOR, TEXTURE = SoTextureCombineElement::TEXTURE, CONSTANT = SoTextureCombineElement::CONSTANT, PREVIOUS = SoTextureCombineElement::PREVIOUS }
enum  Operand { SRC_COLOR = SoTextureCombineElement::SRC_COLOR, ONE_MINUS_SRC_COLOR = SoTextureCombineElement::ONE_MINUS_SRC_COLOR, SRC_ALPHA = SoTextureCombineElement::SRC_ALPHA, ONE_MINUS_SRC_ALPHA = SoTextureCombineElement::ONE_MINUS_SRC_ALPHA }
enum  Operation {
  REPLACE = SoTextureCombineElement::REPLACE, MODULATE = SoTextureCombineElement::MODULATE, ADD = SoTextureCombineElement::ADD, ADD_SIGNED = SoTextureCombineElement::ADD_SIGNED,
  SUBTRACT = SoTextureCombineElement::SUBTRACT, INTERPOLATE = SoTextureCombineElement::INTERPOLATE, DOT3_RGB = SoTextureCombineElement::DOT3_RGB, DOT3_RGBA = SoTextureCombineElement::DOT3_RGBA
}

Public Member Functions

virtual SoType getTypeId (void) const
 SoTextureCombine (void)
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void pick (SoPickAction *action)

Static Public Member Functions

SoType getClassTypeId (void)
void initClass (void)

Public Attributes

SoMFEnum rgbSource
SoMFEnum alphaSource
SoMFEnum rgbOperand
SoMFEnum alphaOperand
SoSFEnum rgbOperation
SoSFEnum alphaOperation
SoSFFloat rgbScale
SoSFFloat alphaScale
SoSFVec4f constantColor

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
virtual ~SoTextureCombine ()

Static Protected Member Functions

const SoFieldData ** getFieldDataPtr (void)


Member Enumeration Documentation

enum SoTextureCombine::Source
 

For enumerating combiner sources.

Enumeration values:
PRIMARY_COLOR  Choose primary color as source.
TEXTURE  Choose texture as source.
CONSTANT  Choose the constantColor field as source.
PREVIOUS  Choose the previous unit's texture as source.

enum SoTextureCombine::Operand
 

For enumerating source operands.

Enumeration values:
SRC_COLOR  Use the source color as operand.
ONE_MINUS_SRC_COLOR  Use one minus source color as operand.
SRC_ALPHA  Use the source alpha as operand.
ONE_MINUS_SRC_ALPHA  Use one minus source alpha as operand.

enum SoTextureCombine::Operation
 

For enumerating combiner operations/functions.

Enumeration values:
REPLACE  dst = Arg0
MODULATE  dst = Arg0 * Arg1
ADD  dst = Arg0 + Arg1
ADD_SIGNED  dst = Arg0 + Arg1 - 0.5
SUBTRACT  dst = Arg0 - Arg1
INTERPOLATE  dst = Arg0 * (Arg2) + Arg1 * (1-Arg2)
DOT3_RGB  Dot product of Arg0 and Arg1
DOT3_RGBA  Dot product (including alpha) of Arg0 and Arg1


Constructor & Destructor Documentation

SoTextureCombine::SoTextureCombine void   ) 
 

Constructor.

SoTextureCombine::~SoTextureCombine  )  [protected, virtual]
 

Destructor.


Member Function Documentation

SoType SoTextureCombine::getClassTypeId void   )  [static]
 

SoTextureCombine::constantColor

The constant color (when CONSTANT is used as source). Default value is (1,1,1,1).

Reimplemented from SoNode.

SoType SoTextureCombine::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 ** SoTextureCombine::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 * SoTextureCombine::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 SoTextureCombine::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 SoTextureCombine::doAction SoAction action  )  [virtual]
 

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

Reimplemented from SoNode.

void SoTextureCombine::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 SoTextureCombine::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 SoTextureCombine::pick SoPickAction action  )  [virtual]
 

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.


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

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

Generated on Tue Jul 13 06:57:57 2004 for Coin by Doxygen. 1.3.6