Class TEffectNode

This item has no description. Showing description inherited from TX3DNode.GroupBeforeTraverse.

React when this node is processed as an immediate child of a grouping node, within grouping node's BeforeTraverse.

This item has no description. Showing description inherited from TX3DNode.Create.

Constructor. Initializes various properties:

• Name, BaseUrl are initialized from given parameters.

• The Fields, Events lists are filled in every descendant, to have all the fields/events defined by the specification.

• DefaultContainerField, and other node-specific stuff, is filled in descendants. This is actually implemented in CreateNode, that is called at the end of this constructor.

Create node fields and events.

This item has no description. Showing description inherited from TX3DNode.ClassX3DType.

Node type name in VRML/X3D, for this class. Normal VRML/X3D node classes should override this to return something non-empty, and then X3DType automatically will return the same value.

Empty for classes that don't have a hardcoded VRML/X3D node name, like a special TX3DUnknownNode. Such special classes should override then X3DType to return actual non-empty name there.

You usually should call X3DType. The only use of this method is that it works on classes (it's "class function"), without needing at actual instance.

This item has no description.

Additional libraries of shader code to link with this effect.

Each "shader library" defines a shader code, just like an additional EffectNode. This code can define new GLSL functions to use in your effect code, e.g. position_world_to_eye_space. This code can also use PLUGs just like other effects, so it can influence the rendering and other computations. The engine has (right now hardcoded) logic to provide necessary uniform values for every shader library, so you don't need to do anything additional to make the added code functional.

Right now, only one shader library is allowed: 'castle-shader:/EyeWorldSpace.glsl'. This is linked with both vertex and fragment stages, and exposes new GLSL functions you can use:

vec4 position_world_to_eye_space(vec4 position_world);
vec4 position_eye_to_world_space(vec4 position_eye);

vec3 direction_world_to_eye_space(vec3 direction_world);
vec3 direction_eye_to_world_space(vec3 direction_eye);

See examples/shaders/shader_effects_on_background/ for a demo.

Additional libraries of shader code to link with this effect.

Each "shader library" defines a shader code, just like an additional EffectNode. This code can define new GLSL functions to use in your effect code, e.g. position_world_to_eye_space. This code can also use PLUGs just like other effects, so it can influence the rendering and other computations. The engine has (right now hardcoded) logic to provide necessary uniform values for every shader library, so you don't need to do anything additional to make the added code functional.

Right now, only one shader library is allowed: 'castle-shader:/EyeWorldSpace.glsl'. This is linked with both vertex and fragment stages, and exposes new GLSL functions you can use:

vec4 position_world_to_eye_space(vec4 position_world);
vec4 position_eye_to_world_space(vec4 position_eye);

vec3 direction_world_to_eye_space(vec3 direction_world);
vec3 direction_eye_to_world_space(vec3 direction_eye);

See examples/shaders/shader_effects_on_background/ for a demo.

Internal wrapper for property Language. This wrapper API may change, we advise to access simpler Language instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Shading language. Only the GLSL (OpenGL Shading Language) is actually supported. The default value, empty string, is equivalent to GLSL.

Internal wrapper for property Enabled. This wrapper API may change, we advise to access simpler Enabled instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

This item has no description.

Internal wrapper for property Parts. This wrapper API may change, we advise to access simpler Parts instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Internal wrapper for property UniformMissing. This wrapper API may change, we advise to access simpler UniformMissing instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).

Should we report a missing uniform value. Setting this to umWarning (default) is useful to spot simple mistakes in naming uniforms. On the other hand, OpenGL aggressively removes unused uniforms from code, and it may cause spurious messages that some uniform is missing – even though the shader is correct, is just doesn't use some uniform value e.g. because no lights are present on the current scene.

Internal wrapper for property ShaderLibraries. This wrapper API may change, we advise to access simpler ShaderLibraries instead, if it is defined (TODO: for now, some field types do not have a simpler counterpart).