.TH "SoVRMLLight" 3 "Thu May 29 2014" "Version 4.0.0a" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoVRMLLight \- 
.PP
The \fBSoVRMLLight\fP class is a superclass for VRML light nodes\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/VRMLnodes/SoVRMLLight\&.h>\fP
.PP
Inherits \fBSoNode\fP\&.
.PP
Inherited by \fBSoVRMLDirectionalLight\fP, \fBSoVRMLPointLight\fP, and \fBSoVRMLSpotLight\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const "
.br
.RI "\fIReturns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for run-time type checking and 'downward' casting\&. \fP"
.ti -1c
.RI "virtual void \fBGLRender\fP (\fBSoGLRenderAction\fP *action)"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBSoSFBool\fP \fBon\fP"
.br
.ti -1c
.RI "\fBSoSFFloat\fP \fBintensity\fP"
.br
.ti -1c
.RI "\fBSoSFColor\fP \fBcolor\fP"
.br
.ti -1c
.RI "\fBSoSFFloat\fP \fBambientIntensity\fP"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual const \fBSoFieldData\fP * \fBgetFieldData\fP (void) const "
.br
.ti -1c
.RI "\fBSoVRMLLight\fP (void)"
.br
.ti -1c
.RI "virtual \fB~SoVRMLLight\fP ()"
.br
.in -1c
.SS "Static Protected Member Functions"

.in +1c
.ti -1c
.RI "static const \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (void)"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
The \fBSoVRMLLight\fP class is a superclass for VRML light nodes\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoVRMLLight::SoVRMLLight (void)\fC [protected]\fP"
Constructor\&. 
.SS "SoVRMLLight::~SoVRMLLight ()\fC [protected]\fP, \fC [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoVRMLLight::getTypeId (void) const\fC [virtual]\fP"

.PP
Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for run-time type checking and 'downward' casting\&. Usage example:
.PP
.PP
.nf
void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}
.fi
.PP
.PP
For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in \fIall\fP 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 \fBInventor/nodes/SoSubNode\&.h\fP (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine\&.h (for engine classes) and so on\&.
.PP
For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups\&. 
.PP
Implements \fBSoBase\fP\&.
.PP
Reimplemented in \fBSoVRMLPointLight\fP, \fBSoVRMLSpotLight\fP, and \fBSoVRMLDirectionalLight\fP\&.
.SS "const \fBSoFieldData\fP * SoVRMLLight::getFieldData (void) const\fC [protected]\fP, \fC [virtual]\fP"
Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fCNULL\fP\&. 
.PP
Reimplemented from \fBSoFieldContainer\fP\&.
.PP
Reimplemented in \fBSoVRMLPointLight\fP, \fBSoVRMLSpotLight\fP, and \fBSoVRMLDirectionalLight\fP\&.
.SS "void SoVRMLLight::GLRender (\fBSoGLRenderAction\fP *action)\fC [virtual]\fP"
Action method for the \fBSoGLRenderAction\fP\&.
.PP
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\&. 
.PP
Reimplemented from \fBSoNode\fP\&.
.PP
Reimplemented in \fBSoVRMLSpotLight\fP, \fBSoVRMLPointLight\fP, and \fBSoVRMLDirectionalLight\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "\fBSoSFBool\fP SoVRMLLight::on"
Enable/disable light\&. Default value is TRUE\&. 
.SS "\fBSoSFFloat\fP SoVRMLLight::intensity"
The light intensity\&. A value from 0 to 1\&. Default value is 1\&. 
.SS "\fBSoSFColor\fP SoVRMLLight::color"
The light color\&. Default value is (1, 1, 1)\&. 
.SS "\fBSoSFFloat\fP SoVRMLLight::ambientIntensity"
The light ambient intensity\&. A value from 0 to 1\&. Default value is 0\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.