trusty (3) SoPointLight.3.gz

NAME

       SoPointLight -

       The SoPointLight class is a node type for light sources.

       Pointlights emits light equally in all directions from a specified 3D location.

SYNOPSIS

       #include <Inventor/nodes/SoPointLight.h>

       Inherits SoLight.

       Inherited by SoPointLightManip.

   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.
       SoPointLight (void)
       virtual void GLRender (SoGLRenderAction *action)

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

   Public Attributes
       SoSFVec3f location

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

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

   Additional Inherited Members

Detailed Description

       The SoPointLight class is a node type for light sources.

       Pointlights emits light equally in all directions from a specified 3D location.

       See also documentation of parent class for important information regarding light sources in general.

       FILE FORMAT/DEFAULTS:

       PointLight {
           on TRUE
           intensity 1
           color 1 1 1
           location 0 0 1
       }

Constructor & Destructor Documentation

   SoPointLight::SoPointLight (void)
       Constructor.

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

Member Function Documentation

   SoType SoPointLight::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 SoLight.

       Reimplemented in SoPointLightManip.

   const SoFieldData * SoPointLight::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 SoLight.

       Reimplemented in SoPointLightManip.

   void SoPointLight::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 SoNode.

       Reimplemented in SoPointLightManip.

Member Data Documentation

   SoSFVec3f SoPointLight::location
       3D position of lightsource. Default value is <0, 0, 1>.

Author

       Generated automatically by Doxygen for Coin from the source code.