This abstract node type is the base type for all node types which specify a programmable shader. More...
#include <H3D/X3DShaderNode.h>
Public Member Functions | |
| X3DShaderNode (Inst< DisplayList > _displayList=0, Inst< SFNode > _metadata=0, Inst< SFBool > _isSelected=0, Inst< SFBool > _isValid=0, Inst< SFBool > _activate=0, Inst< SFString > _language=0) | |
| Constructor. | |
| virtual bool | isSupported () |
| Returns true if the shader node type is supported by the browser. More... | |
| void | setSelected (bool selected) |
| Set the isSelected field. | |
| virtual string | defaultXMLContainerField () |
| Returns the default xml containerField attribute value. More... | |
| virtual bool | isTransparent (X3DMaterialNode *) |
| Returns a hint if the X3DShaderNode produces an alpha channel that is < 1, i.e. More... | |
 Public Member Functions inherited from H3D::X3DAppearanceChildNode | |
| X3DAppearanceChildNode (Inst< DisplayList > _displayList=0, Inst< SFNode > _metadata=0) | |
| Constructor. | |
| virtual void | preRender () |
| This function will be called by the X3DShapeNode before any rendering of geometry and before the call to the render function. More... | |
| virtual void | postRender () |
| This function will be called by the X3DShapeNode after the geometry has been rendered. | |
| virtual GLbitfield | getAffectedGLAttribs () |
| Returns a bitmask of the OpenGL attrib bits that will be affected by this node. More... | |
| 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 | render () |
| the render() function is used for the depth-first rendering traversal of the scene-graph. More... | |
| 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. | |
Static Public Member Functions | |
| static X3DShaderNode * | getActiveShader () |
| Gets the currently active shader, i.e. 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. | |
Public Attributes | |
| H3DUniquePtr< SFBool > | isSelected |
| The isSelected output field is used to indicate that this shader instance is the one selected for use by the browser. More... | |
| H3DUniquePtr< SFBool > | isValid |
| The isValid field is used to indicate whether the current shader objects can be run as a shader program. More... | |
| H3DUniquePtr< SFBool > | activate |
| The activate field forces the shader to activate the contained objects. More... | |
| H3DUniquePtr< EventCollectingField< Field > > | activateMonitor |
| field used to monitor if activate field is modified | |
| H3DUniquePtr< SFString > | language |
| The language field is used to indicate to the browser which shading language is used for the source file(s). 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::X3DNode | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
Additional Inherited Members | |
| 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. | |
| 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
This abstract node type is the base type for all node types which specify a programmable shader.
The isSelected output field is used to indicate that this shader instance is the one selected for use by the browser. A TRUE value indicates that this instance is in use. A FALSE value indicates that this instance is not in use.
The isValid field is used to indicate whether the current shader objects can be run as a shader program. For example, there are no syntax errors and the hardware can support all the required features. The definition of this field may also add additional semantics on a per-language basis.
The language field is used to indicate to the browser which shading language is used for the source file(s). This field may be used as a hint for the browser if the shading language is not immediately determinable from the source (e.g., a generic MIME type of text/plain is returned). A browser may use this field for determining which node instance will be selected and to ignore languages that it is not capable of supporting. H3D API only supports the "GLSL" language.
Member Function Documentation
◆ defaultXMLContainerField()
|
inlinevirtual |
Returns the default xml containerField attribute value.
For this node it is "shader".
Reimplemented from H3D::Node.
◆ getActiveShader()
|
inlinestatic |
Gets the currently active shader, i.e.
the shader that is currently used in OpenGL. NULL us returned if no X3DShaderNode is used.
◆ isSupported()
|
inlinevirtual |
Returns true if the shader node type is supported by the browser.
By default it checks that the language is GLSL.
Reimplemented in H3D::ProgramShader, and H3D::PackagedShader.
Referenced by H3D::Appearance::getAffectedGLAttribs(), and H3D::Appearance::preRender().
◆ isTransparent()
|
inlinevirtual |
Returns a hint if the X3DShaderNode produces an alpha channel that is < 1, i.e.
it is semi-transparent, or not. This is used to determine render order of transparent vs opaque objects.
Reimplemented in H3D::ComposedShader.
Referenced by H3D::Appearance::isTransparent().
Member Data Documentation
◆ activate
| H3DUniquePtr< SFBool > H3D::X3DShaderNode::activate |
The activate field forces the shader to activate the contained objects.
Access type: inputOnly
Referenced by H3D::H3DGeneratedShaderNode::buildShader(), H3D::ComposedShader::ComposedShader(), H3D::PackagedShader::PackagedShader(), H3D::ProgramShader::ProgramShader(), H3D::ComposedShader::render(), H3D::ProgramShader::render(), H3D::ComposedShader::SetupDynamicRoutes::update(), and X3DShaderNode().
◆ isSelected
| H3DUniquePtr< SFBool > H3D::X3DShaderNode::isSelected |
The isSelected output field is used to indicate that this shader instance is the one selected for use by the browser.
A TRUE value indicates that this instance is in use. A FALSE value indicates that this instance is not in use.
Access type: outputOnly
Referenced by H3D::Appearance::postRender(), H3D::Appearance::render(), and X3DShaderNode().
◆ isValid
| H3DUniquePtr< SFBool > H3D::X3DShaderNode::isValid |
The isValid field is used to indicate whether the current shader objects can be run as a shader program.
For example, there are no syntax errors and the hardware can support all the required features.
Access type: outputOnly
Referenced by H3D::ComposedShader::render(), and X3DShaderNode().
◆ language
| H3DUniquePtr< SFString > H3D::X3DShaderNode::language |
The language field is used to indicate to the browser which shading language is used for the source file(s).
This field is ignored in H3D API since only "GLSL" source is allowed.
Access type: outputOnly
Referenced by H3D::H3DGeneratedShaderNode::H3DGeneratedShaderNode(), and H3D::Appearance::preRender().
The documentation for this class was generated from the following files:
