Click or drag to resize
SoQuadAreaLight Class

Node representing a rectangular area light source.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2025.1.0.0 (10.17.0.0)
Syntax
Copy
public class SoQuadAreaLight : SoLight

The SoQuadAreaLight type exposes the following members.

Constructors
  NameDescription
Public methodSoQuadAreaLight

Creates an area light source node with default settings.

Top
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
(Inherited from SoLight.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoLight.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
(Overrides SoNodeGetBoundingBox(SoGetBoundingBoxAction).)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetPrimitiveCount
(Inherited from SoNode.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
(Overrides SoNodeGLRender(SoGLRenderAction).)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoNode.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored.

(Inherited from SoNode.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoNode.)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

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.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoNode.)
Top
Properties
  NameDescription
Public propertycolor

Light source illumination color.

(Inherited from SoLight.)
Public propertyheight

Height of the area.

Public propertyintensity

Illumination intensity of light source.

(Inherited from SoLight.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertylocation

Location of the source (center of the area).

Public propertyon

Determines whether the source is active or inactive.

(Inherited from SoLight.)
Public propertyorientation

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

Public propertytwoSided

Two-Sided illumination.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Public propertywidth

Width of the area.

Top
Remarks

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 OIV.Inventor.Nodes.SoSeparator node to avoid affecting any objects outside that OIV.Inventor.Nodes.SoSeparator.

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

Unlike other light nodes, OIV.Inventor.Nodes.SoQuadAreaLight only supports the OIV.Inventor.Nodes.SoLightModel.Models.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 OIV.Inventor.Nodes.SoQuadAreaLight.location, OIV.Inventor.Nodes.SoQuadAreaLight.orientation, OIV.Inventor.Nodes.SoQuadAreaLight.width, and OIV.Inventor.Nodes.SoQuadAreaLight.height fields define the geometry of the rectangular area covered by the light.

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

FILE FORMAT/DEFAULT

QuadAreaLight {
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

OIV.Inventor.Actions.SoGLRenderAction Activates this light (if so specified) during traversal. All shape nodes that come after this light in the scene graph are illuminated by this light. The current transformation affects the light's direction. Sets: OIV.Inventor.Elements.SoLightElement, SoLightIdElement

Note Note

Node available since Open Inventor 2025.1

See Also