Node representing a rectangular area light source. More...

#include <Inventor/nodes/SoQuadAreaLight.h>

Inheritance diagram for SoQuadAreaLight:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.

	SoQuadAreaLight ()
	Creates an area light source node with default settings.

Public Member Functions inherited from SoNode
virtual void	setOverride (const SbBool state)
	Turns the override flag on or off.

virtual SbBool	isOverride () const
	Returns the state of the override flag.

virtual SoNode *	copy (SbBool copyConnections=FALSE) const
	Creates and returns an exact copy of the node.

virtual SbBool	affectsState () const
	Returns TRUE if a node has an effect on the state during traversal.

virtual void	touch ()
	Marks an instance as modified, simulating a change to it.

Public Member Functions inherited from SoFieldContainer
void	setToDefaults ()
	Sets all fields in this object to their default values.

SbBool	hasDefaultValues () const
	Returns TRUE if all of the object's fields have their default values.

SbBool	fieldsAreEqual (const SoFieldContainer *fc) const
	Returns TRUE if this object's fields are exactly equal to fc's fields.

void	copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE)
	Copies the contents of fc's fields into this object's fields.

SoNONUNICODE SbBool	set (const char *fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

SbBool	set (const SbString &fieldDataString)
	Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

void	get (SbString &fieldDataString)
	Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

virtual int	getFields (SoFieldList &list) const
	Appends references to all of this object's fields to resultList, and returns the number of fields appended.

virtual int	getAllFields (SoFieldList &list) const
	Returns a list of fields, including the eventIn's and eventOut's.

virtual SoField *	getField (const SbName &fieldName) const
	Returns a the field of this object whose name is fieldName.

virtual SoField *	getEventIn (const SbName &fieldName) const
	Returns a the eventIn with the given name.

virtual SoField *	getEventOut (const SbName &fieldName) const
	Returns the eventOut with the given name.

SbBool	getFieldName (const SoField *field, SbName &fieldName) const
	Returns the name of the given field in the fieldName argument.

SbBool	enableNotify (SbBool flag)
	Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE).

SbBool	isNotifyEnabled () const
	Notification is the process of telling interested objects that this object has changed.

virtual void	setUserData (void *data)
	Sets application data.

void *	getUserData (void) const
	Gets user application data.

Public Member Functions inherited from SoBase
virtual SbName	getName () const
	Returns the name of an instance.

virtual void	setName (const SbName &name)
	Sets the name of an instance.

void	setSynchronizable (const bool b)
	Sets this to be a ScaleViz synchronizable object.

bool	isSynchronizable () const
	Gets the ScaleViz synchronizable state of this object.

Public Member Functions inherited from SoRefCounter
void	ref () const
	Adds a reference to an instance.

void	unref () const
	Removes a reference from an instance.

void	unrefNoDelete () const
	unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero.

int	getRefCount () const
	Returns current reference count.

void	lock () const
	lock this instance.

void	unlock () const
	unlock this instance.

Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.

template<typename TypedObjectClass>
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoLight
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Static Public Member Functions inherited from SoNode
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static SoNode *	getByName (const SbName &name)
	A node's name can be set using SoBase::setName().

static int	getByName (const SbName &name, SoNodeList &list)
	A node's name can be set using SoBase::setName().

Static Public Member Functions inherited from SoFieldContainer
static SoType	getClassTypeId ()
	Returns the type of this class.

Static Public Member Functions inherited from SoBase
static SoType	getClassTypeId ()
	Returns type identifier for this class.

Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Public Attributes
SoSFVec3f	location
	Location of the source (center of the area).

SoSFRotation	orientation
	Principal orientation of illumination (normal vector of the area), defined as a SoSFRotation object.

SoSFFloat	width
	Width of the area.

SoSFFloat	height
	Height of the area.

SoSFBool	twoSided
	Two-Sided illumination.

Public Attributes inherited from SoLight
SoSFBool	on
	Determines whether the source is active or inactive.

SoSFFloat	intensity
	Illumination intensity of light source.

SoSFColor	color
	Light source illumination color.

Detailed Description

Node representing a rectangular area light source.

This node defines a light source that covers a rectangular area.

As a light source node, this node affects subsequent shapes in the scene graph, depending on the current lighting model. The current transformation affects this node, and you can place it inside a SoSeparator node to avoid affecting any objects outside that SoSeparator.

You can also use a node kit to create a light; see the reference page for SoLightKit.

Unlike other light nodes, SoQuadAreaLight only supports the SoLightModel::PHYSICALLY_BASED lighting model. This node has no effect on the rendering if any another lighting model is simultaneously used.

Use the color and intensity fiels to control the color and intensity of the light.

The location, orientation, width, and height fields define the geometry of the rectangular area covered by the light.

The twoSided field defines whether or not to use both sides of the rectangular area as a source of illumination.

FILE FORMAT/DEFAULT

on	TRUE
intensity	1
color	1 1 1
location	0 0 0
orientation	0 0 1 0
width	1
height	1
twoSided	FALSE

ACTION BEHAVIOR

SoGLRenderAction

SoLightElement

Constructor & Destructor Documentation

◆ SoQuadAreaLight()

SoQuadAreaLight::SoQuadAreaLight ( )

Creates an area light source node with default settings.

Member Function Documentation

◆ getClassTypeId()

static SoType SoQuadAreaLight::getClassTypeId ( )

static

Returns the type identifier for this class.

◆ getTypeId()

virtual SoType SoQuadAreaLight::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Reimplemented from SoLight.

Member Data Documentation

◆ height

SoSFFloat SoQuadAreaLight::height

Height of the area.

Default is 1.

Definition at line 132 of file SoQuadAreaLight.h.

◆ location

SoSFVec3f SoQuadAreaLight::location

Location of the source (center of the area).

Default is (0, 0, 0).

Definition at line 108 of file SoQuadAreaLight.h.

◆ orientation

SoSFRotation SoQuadAreaLight::orientation

Principal orientation of illumination (normal vector of the area), defined as a SoSFRotation object.

The actual direction of illumination is the vector obtained after applying this rotation to its default (0, 0, -1) vector.

See SoSFRotation and SbRotation for more details.

Definition at line 118 of file SoQuadAreaLight.h.

◆ twoSided

SoSFBool SoQuadAreaLight::twoSided

Two-Sided illumination.

When TRUE, this enables illumination on both sides of the area.

Default is FALSE

Definition at line 141 of file SoQuadAreaLight.h.

◆ width

SoSFFloat SoQuadAreaLight::width

Width of the area.