SoVRMLPointLight Class Reference
[VRML97 nodes]
Node representing a point light source.
More...
#include <Inventor/VRMLnodes/SoVRMLPointLight.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoVRMLPointLight () | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Public Attributes | |
| SoSFVec3f | location |
| SoSFFloat | radius |
| SoSFVec3f | attenuation |
Detailed Description
Node representing a point light source.
The SoVRMLPointLight node specifies a point light source at a 3D location in the local coordinate system. A point source emits light equally in all directions; that is, it is omnidirectional. SoVRMLPointLights are specified in their local coordinate system and are affected by parent transformations.
Note: SoVRMLPointLights only illuminate objects in their enclosing parent group (similar to Directional lights). This is a slight deviation from the behavior described by the VRML97 specification.
NOTE: This class does not exist in Open Inventor 10.0 and later.VRML97 SPECIFICATION
- This section describes the expected behavior of the node in a conforming VRML97 browser application. In some cases, the application is responsible for implementing portions of the expected behavior. Open Inventor viewer classes and IVF classes implement some of the application behaviors.
This section may reference portions of the VRML97 specification that are not present in this help file. The complete VRML97 spec is available at http://www.web3d.org .
The SoVRMLPointLight node specifies a point light source at a 3D location in the local coordinate system. A point source emits light equally in all directions; that is, it is omnidirectional. SoVRMLPointLights are specified in their local coordinate system and are affected by parent transformations.
See "Concepts - Light Sources" for a detailed description of the ambientIntensity , color , and intensity fields.
A SoVRMLPointLight may illuminate geometry within radius (>= 0.0) meters of its location. Both radius and location are affected by parent transformations (scale radius and transform location).
A SoVRMLPointLight's illumination falls off with distance as specified by three attenuation coefficients. The attenuation factor is 1/( attenuation [0] + attenuation [1]*r + attenuation [2]*r^2) , where r is the distance of the light to the surface being illuminated. The default is no attenuation. An attenuation value of 0 0 0 is identical to 1 0 0 . Attenuation values must be >= 0.0. Renderers that do not support a full attenuation model may approximate as necessary. See "Concepts - Lighting Model" for a detailed description of VRML's lighting equations.
FILE FORMAT/DEFAULT
- VRMLPointLight {
| ambientIntensity | 0 |
| attenuation | 1 0 0 |
| color | 1 1 1 |
| intensity | 1 |
| location | 0 0 0 |
| on | TRUE |
| radius | 100 |
| metadata | NULL |
ACTION BEHAVIOR
EVENTS
- Deprecated:
-
Deprecated since Open Inventor 9500
The VRML API is no longer supported. See section http://oivdoc95.vsg3d.com/content/compatibility-notes-4#Deprecation of the Reference Manual. - Inventor/VRMLnodes/SoVRMLPointLight.h
eventIn
| SoSFFloat | set_ambientIntensity |
| SoSFVec3f | set_attenuation |
| SoSFColor | set_color |
| SoSFFloat | set_intensity |
| SoSFVec3f | set_location |
| SoSFBool | set_on |
| SoSFFloat | set_radius (Note: Not implemented) |
| SoSFNode | set_metadata |
eventOut
| SoSFFloat | ambientIntensity_changed |
| SoSFVec3f | attenuation_changed |
| SoSFColor | color_changed |
| SoSFFloat | intensity_changed |
| SoSFVec3f | location_changed |
| SoSFBool | on_changed |
| SoSFFloat | radius_changed (Note: Not implemented) |
| SoSFNode | metadata_changed |
Constructor & Destructor Documentation
| SoVRMLPointLight::SoVRMLPointLight | ( | ) |
Constructor.
Member Function Documentation
| static SoType SoVRMLPointLight::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoVRMLLight.
| virtual SoType SoVRMLPointLight::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoVRMLLight.
Member Data Documentation
Attenuation coefficients.
Location of the source.
(Note: Not implemented) Meters from the location the light can illuminate.
The documentation for this class was generated from the following file: