Rechercher une page de manuel
SoSceneTexture2.3coin2
Langue: en
Version: 380782 (fedora - 01/12/10)
Section: 3 (Bibliothèques de fonctions)
Sommaire
- NAME
- SYNOPSIS
- Detailed Description
- Member Enumeration Documentation
- enum SoSceneTexture2::ModelTexture mapping model, for deciding how to 'merge' the texturemap with the object it is mapped onto.
- enum SoSceneTexture2::WrapEnumeration of wrapping strategies which can be used when the texturemap doesn't cover the full extent of the geometry.
- enum SoSceneTexture2::TransparencyFunctionFor 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.
- Member Function Documentation
- 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.
- void SoSceneTexture2::notify (SoNotList * l) [virtual]Notifies all auditors for this instance when changes are made.
- void SoSceneTexture2::write (SoWriteAction * action) [virtual]Action method for SoWriteAction.
- void SoSceneTexture2::doAction (SoAction * action) [virtual]This function performs the typical operation of a node for any action.
- void SoSceneTexture2::GLRender (SoGLRenderAction * action) [virtual]Action method for the SoGLRenderAction.
- void SoSceneTexture2::callback (SoCallbackAction * action) [virtual]Action method for SoCallbackAction.
- void SoSceneTexture2::rayPick (SoRayPickAction * action) [virtual]Action method for SoRayPickAction.
- void SoSceneTexture2::setType (const Type type)Temporary function in Coin 2.5. Used to set the buffer type. In Coin-3 this function will be obsoleted and replaced with a field.
- void SoSceneTexture2::setSceneTransparencyType (SoNode * node)Temporary function in Coin 2.5. Used to set the scene transparency typex. In Coin-3 this function will be obsoleted and replaced with a field.
- Member Data Documentation
- SoSFEnum SoSceneTexture2::wrapSWrapping strategy for the S coordinate when the texturemap is narrower than the object to map onto.
- SoSFEnum SoSceneTexture2::wrapTWrapping strategy for the T coordinate when the texturemap is shorter than the object to map onto.
- SoSFEnum SoSceneTexture2::modelTexturemapping model for how the texturemap is 'merged' with the polygon primitives it is applied to. Default value is SoSceneTexture2::MODULATE.
- SoSFColor SoSceneTexture2::blendColorBlend color. Used when SoSceneTexture2::model is SoSceneTexture2::BLEND.
- SoSFVec4f SoSceneTexture2::backgroundColorThe color the color buffer is cleared to before rendering the scene. Default value is (0.0f, 0.0f, 0.0f, 0.0f).
- SoSFVec2s SoSceneTexture2::sizeThe size of the texture.
- SoSFNode SoSceneTexture2::sceneThe scene graph that is rendered into the texture.
- SoSFEnum SoSceneTexture2::transparencyFunctionThe transparency function used. Default value is NONE.
- Author
NAME
SoSceneTexture2 -The SoSceneTexture2 class is used to create a 2D texture from a Coin scene graph.
Lets the rendering of a scene graph be specified as a texture image to be used in another scene graph. Set up the scene graph used for a texture in the SoSceneTexture2::scene field.
SYNOPSIS
#include <Inventor/nodes/SoSceneTexture2.h>
Inherits SoNode.
Public Types
enum Model { MODULATE = SoTextureImageElement::MODULATE, DECAL = SoTextureImageElement::DECAL, BLEND = SoTextureImageElement::BLEND, REPLACE = SoTextureImageElement::REPLACE }
enum Wrap { REPEAT = SoTextureImageElement::REPEAT, CLAMP = SoTextureImageElement::CLAMP, CLAMP_TO_BORDER = SoTextureImageElement::CLAMP_TO_BORDER }
enum TransparencyFunction { NONE, ALPHA_BLEND, ALPHA_TEST }
enum Type { DEPTH, RGBA8, RGBA32F, RGB32F, RGBA16F, RGB16F, R3_G3_B2, RGB, RGB4, RGB5, RGB8, RGB10, RGB12, RGB16, RGBA, RGBA2, RGBA4, RGB5_A1, RGB10_A2, RGBA12, RGBA16 }
Public Member Functions
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)
void setType (const Type type)
void setSceneTransparencyType (SoNode *node)
Static Public Member Functions
static void initClass (void)
Public Attributes
SoSFEnum wrapS
SoSFEnum wrapT
SoSFEnum model
SoSFColor blendColor
SoSFVec4f backgroundColor
SoSFVec2s size
SoSFNode scene
SoSFEnum transparencyFunction
Detailed Description
The SoSceneTexture2 class is used to create a 2D texture from a Coin scene graph.
Lets the rendering of a scene graph be specified as a texture image to be used in another scene graph. Set up the scene graph used for a texture in the SoSceneTexture2::scene field.
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.
A notable feature of this node is that it will use offscreen pbuffers for hardware accelerated rendering, if they are available from the OpenGL driver. WGL, GLX and AGL, for OpenGL drivers on Microsoft Windows, X11 and Mac OS X, respectively, all support the OpenGL Architecture Review Board (ARB) pbuffer extension in later incarnations from most OpenGL vendors.
Note also that the offscreen pbuffer will be used directly on the card as a texture, with no costly round trip back and forth from CPU memory, if the OpenGL driver supports the recent ARB_render_texture extension.
An important limitation is that textures should have dimensions that are equal to a whole power-of-two, see documentation for SoSceneTexture::size.
FILE FORMAT/DEFAULTS:
SceneTexture2 { size 256 256 scene NULL backgroundColor 0 0 0 0 transparencyFunction NONE wrapS REPEAT wrapT REPEAT model MODULATE blendColor 0 0 0 }
Since:
- Coin 2.2
Member Enumeration Documentation
enum SoSceneTexture2::ModelTexture 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 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.
enum SoSceneTexture2::WrapEnumeration 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.
enum SoSceneTexture2::TransparencyFunctionFor 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.
Enumerator:
- NONE
- The alpha channel is ignored.
- ALPHA_BLEND
- Alpha blending is used.
- ALPHA_TEST
- An alpha test function is used.
Member Function Documentation
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 * l) [virtual]Notifies all auditors for this instance when changes are made.
Reimplemented from SoNode.
References SoNotList::getLastField(), model, SoNode::notify(), scene, size, transparencyFunction, wrapS, and wrapT.
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.
References SoNode::write().
void SoSceneTexture2::doAction (SoAction * action) [virtual]This function performs the typical operation of a node for any action.
Reimplemented from SoNode.
References blendColor, SoAction::getState(), SoNode::isOverride(), model, SoFieldContainer::set(), size, wrapS, and wrapT.
Referenced by callback(), and rayPick().
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.
References blendColor, SoFieldContainer::get(), SoAction::getState(), SoState::isCacheOpen(), SoNode::isOverride(), model, SoDebugError::postWarning(), scene, and SoFieldContainer::set().
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.
References doAction().
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.
References doAction().
void SoSceneTexture2::setType (const Type type)Temporary function in Coin 2.5. Used to set the buffer type. In Coin-3 this function will be obsoleted and replaced with a field.
void SoSceneTexture2::setSceneTransparencyType (SoNode * node)Temporary function in Coin 2.5. Used to set the scene transparency typex. In Coin-3 this function will be obsoleted and replaced with a field.
References SoBase::ref().
Member Data Documentation
SoSFEnum SoSceneTexture2::wrapSWrapping strategy for the S coordinate when the texturemap is narrower than the object to map onto.
Default value is SoSceneTexture2::REPEAT.
Referenced by doAction(), and notify().
SoSFEnum SoSceneTexture2::wrapTWrapping strategy for the T coordinate when the texturemap is shorter than the object to map onto.
Default value is SoSceneTexture2::REPEAT.
Referenced by doAction(), and notify().
SoSFEnum SoSceneTexture2::modelTexturemapping model for how the texturemap is 'merged' with the polygon primitives it is applied to. Default value is SoSceneTexture2::MODULATE.
Referenced by doAction(), GLRender(), and notify().
SoSFColor SoSceneTexture2::blendColorBlend 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.
Referenced by doAction(), and GLRender().
SoSFVec4f SoSceneTexture2::backgroundColorThe color the color buffer is cleared to before rendering the scene. Default value is (0.0f, 0.0f, 0.0f, 0.0f).
SoSFVec2s SoSceneTexture2::sizeThe 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.
Referenced by doAction(), and notify().
SoSFNode SoSceneTexture2::sceneThe scene graph that is rendered into the texture.
Referenced by GLRender(), and notify().
SoSFEnum SoSceneTexture2::transparencyFunctionThe transparency function used. Default value is NONE.
Referenced by notify().
Author
Generated automatically by Doxygen for Coin from the source code.
Contenus ©2006-2024 Benjamin Poulain
Design ©2006-2024 Maxime Vantorre