trusty (3) SoVRMLDirectionalLight.3.gz

NAME

       SoVRMLDirectionalLight -

       The SoVRMLDirectionalLight class is a node type for specifying directional light sources

       The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is
       copyright The Web3D Consortium, and is used by permission of the Consortium:

SYNOPSIS

       #include <Inventor/VRMLnodes/SoVRMLDirectionalLight.h>

       Inherits SoVRMLLight.

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase. This is used for
           run-time type checking and 'downward' casting.
       SoVRMLDirectionalLight (void)
       virtual void GLRender (SoGLRenderAction *action)

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static void initClass (void)

   Public Attributes
       SoSFVec3f direction

   Protected Member Functions
       virtual const SoFieldData * getFieldData (void) const
       virtual ~SoVRMLDirectionalLight ()

   Static Protected Member Functions
       static const SoFieldData ** getFieldDataPtr (void)

   Additional Inherited Members

Detailed Description

       The SoVRMLDirectionalLight class is a node type for specifying directional light sources

       The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is
       copyright The Web3D Consortium, and is used by permission of the Consortium:

       DirectionalLight {
         exposedField SFFloat ambientIntensity  0        # [0,1]
         exposedField SFColor color             1 1 1    # [0,1]
         exposedField SFVec3f direction         0 0 -1   # (-inf,inf)
         exposedField SFFloat intensity         1        # [0,1]
         exposedField SFBool  on                TRUE
       }

       The DirectionalLight node defines a directional light source that illuminates along rays parallel to a
       given 3-dimensional vector. A description of the ambientIntensity, color, intensity, and on fields is in
       4.6.6, Light sources (http://www.web3d.org/x3d/specifications/vrml/ISO-
       IEC-14772-VRML97/part1/concepts.html#4.6.6).

       The direction field specifies the direction vector of the illumination emanating from the light source in
       the local coordinate system. Light is emitted along parallel rays from an infinite distance away. A
       directional light source illuminates only the objects in its enclosing parent group. The light may
       illuminate everything within this coordinate system, including all children and descendants of its parent
       group. The accumulated transformations of the parent nodes affect the light. DirectionalLight nodes do
       not attenuate with distance. A precise description of VRML's lighting equations is contained in 4.14,
       Lighting model (http://www.web3d.org/x3d/specifications/vrml/ISO-
       IEC-14772-VRML97/part1/concepts.html#4.6.14).

Constructor & Destructor Documentation

   SoVRMLDirectionalLight::SoVRMLDirectionalLight (void)
       Constructor.

   SoVRMLDirectionalLight::~SoVRMLDirectionalLight () [protected],  [virtual]
       Destructor.

Member Function Documentation

   SoType SoVRMLDirectionalLight::getTypeId (void) const [virtual]
       Returns the type identification of an object derived from a class inheriting SoBase. This is used for
       run-time type checking and 'downward' casting. Usage example:

       void foo(SoNode * node)
       {
         if (node->getTypeId() == SoFile::getClassTypeId()) {
           SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
         }
       }

       For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or
       others: this method needs to be overridden in all subclasses. This is typically done as part of setting
       up the full type system for extension classes, which is usually accomplished by using the pre-defined
       macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and
       SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

       For more information on writing Coin extensions, see the class documentation of the toplevel superclasses
       for the various class groups.

       Reimplemented from SoVRMLLight.

   const SoFieldData * SoVRMLDirectionalLight::getFieldData (void) const [protected],  [virtual]
       Returns a pointer to the class-wide field data storage object for this instance. If no fields are
       present, returns NULL.

       Reimplemented from SoVRMLLight.

   void SoVRMLDirectionalLight::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 SoVRMLLight.

Member Data Documentation

   SoSFVec3f SoVRMLDirectionalLight::direction
       The light direction.

Author

       Generated automatically by Doxygen for Coin from the source code.