'\"! tbl | mmdoc
'\"macro stdmacro
.ie n \{\
.   ds Cr \fB
.   ds Cb \fB
.\}
.el \{\
.   ds Cr \f7
.   ds Cb \f8
.\}
.TH SoLightKit(3IV)
.SH NAME
SoLightKit \(em light nodekit class 
.SH INHERITS FROM
SoBase > SoFieldContainer > SoNode > SoBaseKit > SoLightKit
.SH SYNOPSIS
.ps -1
\*(Cr#include <Inventor/nodekits/SoLightKit.h>
.sp
.in 1i
\f1Parts from class SoLightKit:
.in 0.5i
.sp
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr(SoTransform)
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbtransform\*(Cr
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr(SoLight)
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cblight\*(Cr
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr(SoNode)
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbicon\*(Cr
.sp
.in 1i
\f1Parts from class SoBaseKit:
.in 0.5i
.sp
.ta 21m
.in 1i+21n
.ti 0.5i
.ta 21m
.ds Pt \*(Cr(SoNodeKitListPart)
.ie \w'\*(Pt'>=21n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbcallbackList\*(Cr
.sp
.in 1i
\f1Methods from class SoLightKit:
.in 0.5i
.sp
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSoLightKit\*(Cr()
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crstatic const SoNodekitCatalog *
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetClassNodekitCatalog\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crstatic SoType
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetClassTypeId\*(Cr()
.sp
.in 1i
\f1Methods from class SoBaseKit:
.in 0.5i
.sp
.ta 25m
.in 1i+25n
.ti 0.5i
.ta 25m
.ds Pt \*(Crvirtual const SoNodekitCatalog *
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetNodekitCatalog\*(Cr() const
.br
.in 1i+25n
.ti 0.5i
.ta 25m
.ds Pt \*(Crvirtual SoNode *
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetPart\*(Cr(const SbName &partName, SbBool makeIfNeeded)
.br
.in 1i+25n
.ti 0.5i
.ta 25m
.ds Pt \*(CrSbString
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetPartString\*(Cr(const SoBase *part)
.br
.in 1i+25n
.ti 0.5i
.ta 25m
.ds Pt \*(Crvirtual SoNodeKitPath *
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbcreatePathToPart\*(Cr(const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend = NULL)
.br
.in 1i+25n
.ti 0.5i
.ta 25m
.ds Pt \*(Crvirtual SbBool
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetPart\*(Cr(const SbName &partName, SoNode *newPart)
.br
.in 1i+25n
.ti 0.5i
.ta 25m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbset\*(Cr(char *partName, char *parameters)
.br
.in 1i+25n
.ti 0.5i
.ta 25m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbset\*(Cr(char *nameValuePairs)
.br
.in 1i+25n
.ti 0.5i
.ta 25m
.ds Pt \*(Crstatic SbBool
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbisSearchingChildren\*(Cr()
.br
.in 1i+25n
.ti 0.5i
.ta 25m
.ds Pt \*(Crstatic void
.ie \w'\*(Pt'>=25n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetSearchingChildren\*(Cr(SbBool newVal)
.sp
.in 1i
\f1Methods from class SoNode:
.in 0.5i
.sp
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetOverride\*(Cr(SbBool state)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbisOverride\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSoNode *
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbcopy\*(Cr(SbBool copyConnections = FALSE) const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual SbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbaffectsState\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crstatic SoNode *
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetByName\*(Cr(const SbName &name)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crstatic int
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetByName\*(Cr(const SbName &name, SoNodeList &list)
.sp
.in 1i
\f1Methods from class SoFieldContainer:
.in 0.5i
.sp
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetToDefaults\*(Cr()
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbhasDefaultValues\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbfieldsAreEqual\*(Cr(const SoFieldContainer *fc) const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbcopyFieldValues\*(Cr(const SoFieldContainer *fc, SbBool copyConnections = FALSE)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbget\*(Cr(SbString &fieldDataString)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual int
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetFields\*(Cr(SoFieldList &resultList) const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual SoField *
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetField\*(Cr(const SbName &fieldName) const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetFieldName\*(Cr(const SoField *field, SbName &fieldName) const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbisNotifyEnabled\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbenableNotify\*(Cr(SbBool flag)
.sp
.in 1i
\f1Methods from class SoBase:
.in 0.5i
.sp
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbref\*(Cr()
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbunref\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbunrefNoDelete\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvoid
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbtouch\*(Cr()
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual SoType
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetTypeId\*(Cr() const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(CrSbBool
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbisOfType\*(Cr(SoType type) const
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual void
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbsetName\*(Cr(const SbName &name)
.br
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crvirtual SbName
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetName\*(Cr() const
.sp
.in 1i
\f1Macros from class SoBaseKit:
.in 0.5i
.sp
\*(CbSO_GET_PART\*(Cr(kit, partName, partClass)
	
.br
\*(CbSO_CHECK_PART\*(Cr(kit, partName, partClass)
	
.sp
.SH DESCRIPTION
This nodekit class is used to create light nodes that have a local transformation and a geometry icon to represent the light source. \*(CbSoLightKit\f1 adds three public parts to the basic nodekit: \f2transform\f1, \f2light\f1, and \f2icon\f1. 
.sp
\*(CbSoLightKit\f1 creates an \*(CbSoDirectionalLight\f1
\&as the \f2light\f1 part by default - all other parts are \*(CrNULL\f1 at creation. 
.sp
You can move the light relative to the rest of the scene by creating and editing the \f2transform\f1 part. 
.sp
You can add a geometrical representation for the
\&light by setting the \f2icon\f1 part to be any scene graph you like. 
.sp
\*(CbSoLightKit\f1 also adds two private parts. An \*(CbSoTransformSeparator\f1 contains the effect of \f2transform\f1 to move only the \f2light\f1 and \f2icon\f1, while allowing the \f2light\f1 to illuminate the rest of the scene. The
\&second private part is an \*(CbSoSeparator\f1, which keeps property nodes within the \f2icon\f1 geometry from affecting the rest of the scene. It also serves to cache the \f2icon\f1 even when the \f2light\f1 or \f2transform\f1 is changing. 
.sp
\*(CbSoLightKit\f1 is derived from \*(CbSoBaseKit\f1 and thus
\&also includes a \f2callbackList\f1 part for adding callback nodes. 
.SH PARTS
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr(SoTransform)
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbtransform\*(Cr
.br
.in 1i
\f1This part positions and orients the light and icon relative to the rest of the scene. Its effect is kept local to this nodekit by a private part of type \*(CbSoTransformSeparator\f1. The \f2transform\f1 part is \*(CrNULL\f1 by default. If you
\&ask for \f2transform\f1 using \*(CbgetPart()\f1, an \*(CbSoTransform\f1 will be returned. But you may set the part to be any subclass of \*(CbSoTransform\f1. For example, set the \f2transform\f1 to be an \*(CbSoDragPointManip\f1 and the \f2light\f1 to be an \*(CbSoPointLight\f1. Then you can move the light by dragging
\&the manipulator with the mouse. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr(SoLight)
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cblight\*(Cr
.br
.in 1i
\f1The light node for this nodekit. This can be set to any node derived from \*(CbSoLight\f1. An \*(CbSoDirectionalLight\f1 is created by default, and it is also the type of light returned when the you request that the nodekit build
\&a light for you. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr(SoNode)
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(Cbicon\*(Cr
.br
.in 1i
\f1This part is a user-supplied scene graph that represents the light source. It is \*(CrNULL\f1 by default \(em an \*(CbSoCube\f1 is created by the lightkit when a method requires it to build the part itself. 
.sp
.in 0.5i
.SH METHODS
.ta 20m
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Cr
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbSoLightKit\*(Cr()
.br
.in 1i
\f1Constructor. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crstatic const SoNodekitCatalog *
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetClassNodekitCatalog\*(Cr() const
.br
.in 1i
\f1Returns an \*(CbSoNodekitCatalog\f1 for the class \*(CbSoLightKit\f1. 
.sp
.in 0.5i
.in 1i+20n
.ti 0.5i
.ta 20m
.ds Pt \*(Crstatic SoType
.ie \w'\*(Pt'>=20n \{\
.ne 3
\*(Pt
.ti 0.5i
	\c\
\}
.el\{\
.ne 2
\*(Pt	\c\
\}
\*(CbgetClassTypeId\*(Cr()
.br
.in 1i
\f1Returns type identifier for this class. 
.sp
.in 0.5i
.SH CATALOG PARTS
.ne 13
.TS
box, tab(!);
cb s  s  s
lb lb lb lb
lb lb lb lb
l  l  l  c.
All parts
!!!NULL by
Part Name!Part Type!Default Type!Default

callbackList!NodeKitListPart!--!yes
transform!Transform!--!yes
light!Light!DirectionalLight!no
icon!Node!Cube!yes

.TE
.ne 10
.TS
box, tab(!);
cb s  s
lb lb lbw(30n)
l  l  l.
Extra information for list parts from above table
.sp
Part Name!Container Type!Permissible Types

callbackList!Separator!T{
Callback, EventCallback
T}

.TE
.SH FILE FORMAT/DEFAULTS
.nf
\*(CrLightKit {
.in 1i
.ta 14m
callbackList	NULL
transform	NULL
light	DirectionalLight {
}

icon	NULL
.in 0.5i
}
.SH SEE ALSO
\*(CbSoAppearanceKit, SoBaseKit, SoCameraKit, SoNodeKit, SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoNodekitCatalog, SoSceneKit, SoSeparatorKit, SoShapeKit, SoWrapperKit