MultiTexture enables the application of several individual textures to a 3D object to achieve a more complex visual effect. More...
#include <H3D/MultiTexture.h>
Inheritance diagram for H3D::MultiTexture:
Public Types | |
| typedef DependentMFNode< X3DTextureNode, FieldRef< H3DDisplayListObject, H3DDisplayListObject::DisplayList, &H3DDisplayListObject::displayList >, true > | MFTexture |
| An MFNode where we make sure the type of the nodes contained is a subclass of X3DTextureNode. | |
 Public Types inherited from H3D::Node | |
| typedef std::map< Node *, Node * > | DeepCopyMap |
| A map type used during a deep copy clone() to map from original nodes to cloned nodes. | |
Public Member Functions | |
| MultiTexture (Inst< DisplayList > _displayList=0, Inst< SFFloat > _alpha=0, Inst< SFColor > _color=0, Inst< MFString > _function=0, Inst< SFNode > _metadata=0, Inst< MFString > _mode=0, Inst< MFString > _source=0, Inst< MFTexture > _texture=0) | |
| Constructor. | |
| virtual void | render () |
| Install the textures in OpenGL. | |
| virtual void | enableTexturing () |
| Enable texturing for all textures in the MultiTexture. | |
| virtual void | disableTexturing () |
| Disable texturing for all textures in the MultiTexture. | |
| Public Member Functions inherited from H3D::X3DTextureNode | |
| X3DTextureNode (Inst< DisplayList > _displayList=0, Inst< SFNode > _metadata=0, Inst< UpdateSaveToURL > _saveToUrl=0, Inst< SFBool > _saveSuccess=0, Inst< SFInt32 > _saveHeight=0, Inst< SFInt32 > _saveWidth=0) | |
| Constructor. | |
| virtual string | defaultXMLContainerField () |
| Returns the default xml containerField attribute value. More... | |
| virtual void | preRender () |
| This function will be called by the X3DShapeNode before any rendering of geometry and before the call to the render function. | |
| virtual void | postRender () |
| This function will be called by the X3DShapeNode after the geometry has been rendered to restore the states to what it was before the call to preRender(). | |
| virtual GLbitfield | getAffectedGLAttribs () |
| Returns a bitmask of the OpenGL attrib bits that will be affected by this node. More... | |
| virtual Vec3f | textureSize () |
| Sometimes the texture represents a volume in space, e.g. More... | |
| virtual GLuint | renderImage (Image *image, GLenum texture_target, bool scale_to_power_of_two) |
| Installs the image as a OpenGL texture. More... | |
| virtual GLint | glInternalFormat (Image *image) |
| Returns the internal OpenGL format to use given an Image, e.g. More... | |
| virtual GLenum | glPixelFormat (Image *image) |
| Returns the OpenGL pixel format to use given an Image, e.g. More... | |
| virtual GLenum | glPixelComponentType (Image *image) |
| Returns the OpenGL pixel compnent type to use given an Image, e.g. More... | |
| virtual void | glTexImage (Image *, GLenum, bool) |
| Install the given image as a OpenGL texture with a call to a glTexImage function. More... | |
| virtual Image * | renderToImage (H3DInt32 _width, H3DInt32 _height, bool output_float_texture=false) |
| Create a new Image object which contains the result of rendering this texture. More... | |
| Public Member Functions inherited from H3D::X3DAppearanceChildNode | |
| X3DAppearanceChildNode (Inst< DisplayList > _displayList=0, Inst< SFNode > _metadata=0) | |
| Constructor. | |
| Public Member Functions inherited from H3D::X3DNode | |
| X3DNode (Inst< SFNode > _metadata=0) | |
| Constructor. | |
| X3DMetadataObject * | getMetadataByName (const string &_name) |
| Given a name, the first X3DMetadataObject in the metadata field that matches that name is returned. More... | |
| Public Member Functions inherited from H3D::Node | |
| Node () | |
| Constructor. | |
| virtual Node * | clone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL) |
| Returns a new instance of this node type with the same state as this one. More... | |
| virtual | ~Node () |
| Destructor. | |
| X3DPrototypeInstance * | getProtoInstanceParent () |
| If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More... | |
| void | setProtoInstanceParent (X3DPrototypeInstance *p) |
| Set the X3DPrototypeInstance this node is the the root node if applicaple. | |
| virtual void | traverseSG (TraverseInfo &ti) |
| traverseSG is called once per scenegraph loop on the scene in order to traverse the scenegraph. More... | |
| virtual bool | lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result) |
| Detect intersection between a line segment and the Node. More... | |
| virtual void | closestPoint (const Vec3f &p, NodeIntersectResult &result) |
| Find closest point on Node to p. More... | |
| virtual bool | movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result) |
| Detect collision between a moving sphere and the Node. More... | |
| virtual Field * | getField (const string &_name) const |
| return a pointer to the field specified by name within this instance | |
| int | addDestructCallback (void(*func)(Node *, void *), void *args) |
| Add a callback function to be run on destruction of node. More... | |
| int | removeDestructCallback (void(*func)(Node *, void *), void *args) |
| Add a callback function to be run on destruction of node. More... | |
| Public Member Functions inherited from H3D::H3DDisplayListObject | |
| H3DDisplayListObject (Inst< DisplayList > _displayList=0) | |
| Constructor. | |
Public Attributes | |
| H3DUniquePtr< SFFloat > | alpha |
| Base alpha value for SELECT mode operations. More... | |
| H3DUniquePtr< SFColor > | color |
| Base alpha value for SELECT mode operations. More... | |
| H3DUniquePtr< MFString > | function |
| The function field defines an optional function to be applied to the argument after the mode has been evaluated. More... | |
| H3DUniquePtr< MFString > | mode |
| The mode field controls the type of blending operation. More... | |
| H3DUniquePtr< MFString > | source |
| The source field determines the colour source for the second argument. More... | |
| H3DUniquePtr< MFTexture > | texture |
| The texture field contains a list of X3DTextureNode instances (e.g., ImageTexture, PixelTexture and MultiTexture). More... | |
| Public Attributes inherited from H3D::X3DTextureNode | |
| H3DUniquePtr< UpdateSaveToURL > | saveToUrl |
| When a new value is specified for saveToUrl the current texture is rendered to a buffer and saved to the specified filename. More... | |
| H3DUniquePtr< SFBool > | saveSuccess |
| Contains the result of the last save operation. More... | |
| H3DUniquePtr< SFInt32 > | saveHeight |
| The height of the image to write to file when the saveToUrl field is used. More... | |
| H3DUniquePtr< SFInt32 > | saveWidth |
| The width of the image to write to file when the saveToUrl field is used. More... | |
| Public Attributes inherited from H3D::X3DNode | |
| H3DUniquePtr< SFNode > | metadata |
| Meta data about the node. More... | |
| Public Attributes inherited from H3D::H3DDisplayListObject | |
| H3DUniquePtr< DisplayList > | displayList |
| The DisplayList instance handling the OpenGL caching of this object. | |
Static Public Attributes | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| Static Public Attributes inherited from H3D::X3DTextureNode | |
| static bool | load_images_in_separate_thread = true |
| This is the default value for the GlobalSettings::loadTexturesInThread field. More... | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| Static Public Attributes inherited from H3D::X3DNode | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from H3D::X3DTextureNode | |
| static X3DTextureNode * | getActiveTexture () |
| Gets the currently active texture, i.e. More... | |
| static void | setActiveTexture (X3DTextureNode *t) |
| Set the active texture. More... | |
| Static Public Member Functions inherited from H3D::Node | |
| static unsigned int | nrNodesAlive () |
| Returns the nr of nodes currently alive, i.e. nodes created but not destructed. | |
| static int | nrNodesCreated () |
| Returns the number of nodes created in total since the start of the program. | |
| Protected Member Functions inherited from H3D::X3DTextureNode | |
| virtual std::pair< H3DInt32, H3DInt32 > | getDefaultSaveDimensions () |
| Returns the default dimensions to use when this texture is saved to file. More... | |
| GLint | glCompressedInternalFormat (GLint _format, const std::string &_compression) |
| Given a non-compressed internal format, return an equivelent compressed format based on the compression settings. More... | |
| Protected Member Functions inherited from H3D::Node | |
| void | cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap) |
| A helper function for the clone() method. More... | |
| Static Protected Member Functions inherited from H3D::Node | |
| static Node * | getClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap) |
| A helper function for nodes that implement clone() More... | |
Detailed Description
MultiTexture enables the application of several individual textures to a 3D object to achieve a more complex visual effect.
MultiTexture can be used as a value for the texture field in an Appearance node. The texture field contains a list of texture nodes (e.g., ImageTexture, PixelTexture, MovieTexture, and MultiTexture). The texture field may not contain another MultiTexture node.
- The color and alpha fields define base RGB and alpha values for SELECT mode operations.
- The mode field controls the type of blending operation. "MODULATE" Multiply texture color with current color. Arg1 * Arg2 "REPLACE" Replace current color. Arg2. "MODULATE2X" Multiply the components of the arguments, and shift the products to the left 1 bit (effectively multiplying them by 2) for brightening. "MODULATE4X" Multiply the components of the arguments, and shift the products to the left 2 bits (effectively multiplying them by 4) for brightening. "ADD" Add the components of the arguments. Arg1 + Arg2 "ADDSIGNED" Add the components of the arguments with a -0.5 bias, making the effective range of values from -0.5 through 0.5. "ADDSIGNED2X" Add the components of the arguments with a -0.5 bias, and shift the products to the left 1 bit. "SUBTRACT" Subtract the components of the second argument from those of the first argument. Arg1 - Arg2. "BLENDDIFFUSEALPHA" Linearly blend this texture stage, using the interpolated alpha from each vertex. Arg1 * (Alpha) + Arg2 * (1-Alpha). "BLENDTEXTUREALPHA" Linearly blend this texture stage, using the alpha from this stage's texture. Arg1 * (Alpha) + Arg2 * (1 - Alpha). "BLENDFACTORALPHA" Linearly blend this texture stage, using the alpha factor from the MultiTexture node. Arg1 × (Alpha) + Arg2 × (1 = Alpha). "BLENDCURRENTALPHA" Linearly blend this texture stage, using the alpha taken from the previous texture stage. Arg1 * (Alpha)+Arg2*(1 - Alpha) "OFF" Turn off the texture unit "SELECTARG1" Use color argument 1. Arg1. "SELECTARG2" Use color argument 2. Arg2. "DOTPRODUCT3" Modulate the components of each argument (as signed components), add their products, then replicate the sum to all color channels, including alpha. This can do either diffuse or specular bump mapping with correct input. Performs the function (Arg1.R × Arg2.R + Arg1.G × Arg2.G + Arg1.B × Arg2.B) where each component has been scaled and offset to make it signed. The result is replicated into all four (including alpha) channels.
- The function field defines an optional function to be applied to the argument after the mode has been evaluated. "" (default) No function is applied. "COMPLEMENT" Invert the argument so that, if the result of the argument were referred to by the variable x, the value would be 1.0 minus x. "ALPHAREPLICATE" Replicate the alpha information to all color channels before the operation completes.
- The source field determines the colour source for the second argument. "" (default) The second argument color (ARG2) is the color from the previous rendering stage (DIFFUSE for first stage). "DIFFUSE" The texture argument is the diffuse color interpolated from vertex components during Gouraud shading. "FACTOR" The texture argument is the factor (color, alpha) from the MultiTexture node.
- The texture field contains a list of X3DTextureNode instances (e.g., ImageTexture, PixelTexture and MultiTexture). The texture field may not contain another MultiTexture node.
Examples:
- Internal routes:
Member Data Documentation
◆ alpha
| H3DUniquePtr< SFFloat > H3D::MultiTexture::alpha |
Base alpha value for SELECT mode operations.
Access type: inputOutput
Default value: 1
Valid range: [0-1]
Referenced by MultiTexture(), and render().
◆ color
| H3DUniquePtr< SFColor > H3D::MultiTexture::color |
Base alpha value for SELECT mode operations.
Access type: inputOutput
Default value: RGB( 1, 1, 1 )
Valid range: [0-1]
Referenced by MultiTexture(), and render().
◆ function
| H3DUniquePtr< MFString > H3D::MultiTexture::function |
The function field defines an optional function to be applied to the argument after the mode has been evaluated.
This is not supported at this time.
Access type: inputOutput
Referenced by render().
◆ mode
| H3DUniquePtr< MFString > H3D::MultiTexture::mode |
The mode field controls the type of blending operation.
The only available mode at this time is "MODULATE".
Access type: inputOutput
Referenced by MultiTexture(), and render().
◆ source
| H3DUniquePtr< MFString > H3D::MultiTexture::source |
The source field determines the colour source for the second argument.
This is not supported at this time.
Access type: inputOutput
Referenced by MultiTexture(), and render().
◆ texture
| H3DUniquePtr< MFTexture > H3D::MultiTexture::texture |
The texture field contains a list of X3DTextureNode instances (e.g., ImageTexture, PixelTexture and MultiTexture).
The texture field may not contain another MultiTexture node.
Access type: inputOutput
Referenced by H3D::X3DTextureCoordinateNode::disableArrayForTexture(), disableTexturing(), H3D::X3DTextureCoordinateNode::disableVBOForTexture(), H3D::X3DTextureCoordinateNode::disableVertexBufferObjectForTexture(), enableTexturing(), MultiTexture(), H3D::X3DTextureTransformNode::postRender(), H3D::X3DTextureTransformNode::preRender(), H3D::Appearance::render(), render(), H3D::TriangleSet2D::render(), H3D::X3DTextureCoordinateNode::renderArrayForTexture(), H3D::X3DTextureCoordinateNode::renderForTexture(), H3D::X3DTextureCoordinateNode::renderTexCoordForTexture(), H3D::X3DTextureCoordinateNode::renderVertexBufferObjectForTexture(), H3D::SuperShape::startTexGen(), H3D::ElevationGrid::startTexGen(), H3D::X3DComposedGeometryNode::startTexGen(), H3D::X3DTextureCoordinateNode::startTexGenForTexture(), H3D::SuperShape::stopTexGen(), H3D::ElevationGrid::stopTexGen(), H3D::X3DComposedGeometryNode::stopTexGen(), and H3D::X3DTextureCoordinateNode::stopTexGenForTexture().
The documentation for this class was generated from the following files:
