2003-04-18 00:22:51 +08:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
< HTML >
< HEAD >
< TITLE > class SG_EXPORT osg::Light< / TITLE >
2004-08-06 14:53:36 +08:00
< META NAME = "GENERATOR" CONTENT = "DOC++ 3.4.6" >
2003-04-18 00:22:51 +08:00
< / HEAD >
< BODY BGCOLOR = "#ffffff" >
< H2 > class SG_EXPORT < A HREF = "#DOC.DOCU" > osg::Light< / A > < / H2 > < / H2 > < BLOCKQUOTE > Light state class which encapsulates OpenGL glLight() functionality< / BLOCKQUOTE >
< HR >
< H2 > Inheritance:< / H2 >
< APPLET CODE = "ClassGraph.class" WIDTH = 600 HEIGHT = 125 >
< param name = classes value = "CReferenced,MReferenced.html,CObject,MObject.html,CStateAttribute,MStateAttribute.html,CLight,MLight.html" >
< param name = before value = "M,M,M,M" >
< param name = after value = "Md_SPSP,Md_SP,Md_,M" >
< param name = indent value = "0,1,2,3" >
< param name = arrowdir value = "down" >
< / APPLET >
< HR >
< DL >
< P > < DL >
< DT > < H3 > Public Methods< / H3 > < DD > < DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > < B > < A HREF = "#DOC.2.126.1" > Light< / A > < / B > ()
2003-04-18 00:22:51 +08:00
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > < B > < A HREF = "#DOC.2.126.2" > Light< / A > < / B > (const <!1> < A HREF = "Light.html#DOC.2.126.2" > Light< / A > & light, const <!1> < A HREF = "CopyOp.html" > CopyOp< / A > & copyop=CopyOp::SHALLOW_COPY)
2003-04-18 00:22:51 +08:00
< DD > < I > Copy constructor using CopyOp to manage deep vs shallow copy< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > < B > < A HREF = "#DOC.2.126.3" > META_StateAttribute< / A > < / B > (<!1> < A HREF = "osg.html" > osg< / A > , <!1> < A HREF = "Light.html" > Light< / A > , (<!1> < A HREF = "StateAttribute.html#DOC.2.229.5" > Type< / A > )(<!1> < A HREF = "StateAttribute.html#DOC.2.229.6.12" > LIGHT_0< / A > +<!1> < A HREF = "Light.html#DOC.2.126.32" > _lightnum< / A > ))
2003-04-18 00:22:51 +08:00
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > virtual int < B > < A HREF = "#DOC.2.126.4" > compare< / A > < / B > (const <!1> < A HREF = "StateAttribute.html" > StateAttribute< / A > & sa) const
2003-04-18 00:22:51 +08:00
< DD > < I > return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > virtual bool < B > < A HREF = "#DOC.2.126.5" > getModeUsage< / A > < / B > (<!1> < A HREF = "StateAttribute.html#DOC.2.229.20" > ModeUsage< / A > & usage) const
2003-04-18 00:22:51 +08:00
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > void < B > < A HREF = "#DOC.2.126.6" > setLightNum< / A > < / B > (int num)
2003-04-18 00:22:51 +08:00
< DD > < I > Set which OpenGL light to operate on< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > int < B > < A HREF = "#DOC.2.126.7" > getLightNum< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > Get which OpenGL light this osg::Light operates on< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.126.8" > setAmbient< / A > < / B > ( const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & ambient )
2003-04-18 00:22:51 +08:00
< DD > < I > Set the ambient component of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & < B > < A HREF = "#DOC.2.126.9" > getAmbient< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > Get the ambient component of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.126.10" > setDiffuse< / A > < / B > ( const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & diffuse )
2003-04-18 00:22:51 +08:00
< DD > < I > Set the diffuse component of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & < B > < A HREF = "#DOC.2.126.11" > getDiffuse< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > Get the diffuse component of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.126.12" > setSpecular< / A > < / B > ( const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & specular )
2003-04-18 00:22:51 +08:00
< DD > < I > Set the specular component of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & < B > < A HREF = "#DOC.2.126.13" > getSpecular< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > Get the specular component of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.126.14" > setPosition< / A > < / B > ( const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & position )
2003-04-18 00:22:51 +08:00
< DD > < I > Set the position of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & < B > < A HREF = "#DOC.2.126.15" > getPosition< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > Get the position of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.126.16" > setDirection< / A > < / B > ( const <!1> < A HREF = "osg.html#DOC.2.262" > Vec3< / A > & direction )
2003-04-18 00:22:51 +08:00
< DD > < I > Set the direction of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline const <!1> < A HREF = "osg.html#DOC.2.262" > Vec3< / A > & < B > < A HREF = "#DOC.2.126.17" > getDirection< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > Get the direction of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.126.18" > setConstantAttenuation< / A > < / B > ( float constant_attenuation )
2003-04-18 00:22:51 +08:00
< DD > < I > Set the constant attenuation of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline float < B > < A HREF = "#DOC.2.126.19" > getConstantAttenuation< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > Get the constant attenuation of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.126.20" > setLinearAttenuation< / A > < / B > ( float linear_attenuation )
2003-04-18 00:22:51 +08:00
< DD > < I > Set the linear attenuation of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline float < B > < A HREF = "#DOC.2.126.21" > getLinearAttenuation< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > Get the linear attenuation of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.126.22" > setQuadraticAttenuation< / A > < / B > ( float quadratic_attenuation )
2003-04-18 00:22:51 +08:00
< DD > < I > Set the quadratic attenuation of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline float < B > < A HREF = "#DOC.2.126.23" > getQuadraticAttenuation< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > Get the quadratic attenuation of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.126.24" > setSpotExponent< / A > < / B > ( float spot_exponent )
2003-04-18 00:22:51 +08:00
< DD > < I > Set the spot exponent of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline float < B > < A HREF = "#DOC.2.126.25" > getSpotExponent< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > Get the spot exponent of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline void < B > < A HREF = "#DOC.2.126.26" > setSpotCutoff< / A > < / B > ( float spot_cutoff )
2003-04-18 00:22:51 +08:00
< DD > < I > Set the spot cutoff of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > inline float < B > < A HREF = "#DOC.2.126.27" > getSpotCutoff< / A > < / B > () const
2003-04-18 00:22:51 +08:00
< DD > < I > Get the spot cutoff of the light.< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > void < B > < A HREF = "#DOC.2.126.28" > captureLightState< / A > < / B > ()
2003-04-18 00:22:51 +08:00
< DD > < I > Capture the lighting settings of the current OpenGL state and store them in this object< / I >
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > virtual void < B > < A HREF = "#DOC.2.126.29" > apply< / A > < / B > (<!1> < A HREF = "State.html" > State< / A > & state) const
2003-04-18 00:22:51 +08:00
< DD > < I > Apply the light's state to the OpenGL state machine.< / I >
< / DL > < / P >
< P > < DL >
< DT > < H3 > Protected Fields< / H3 > < DD > < DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > int < B > < A HREF = "#DOC.2.126.32" > _lightnum< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > < B > < A HREF = "#DOC.2.126.33" > _ambient< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > < B > < A HREF = "#DOC.2.126.34" > _diffuse< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > < B > < A HREF = "#DOC.2.126.35" > _specular< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > < B > < A HREF = "#DOC.2.126.36" > _position< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > <!1> < A HREF = "osg.html#DOC.2.262" > Vec3< / A > < B > < A HREF = "#DOC.2.126.37" > _direction< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > float < B > < A HREF = "#DOC.2.126.38" > _constant_attenuation< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > float < B > < A HREF = "#DOC.2.126.39" > _linear_attenuation< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > float < B > < A HREF = "#DOC.2.126.40" > _quadratic_attenuation< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > float < B > < A HREF = "#DOC.2.126.41" > _spot_exponent< / A > < / B >
2003-04-18 00:22:51 +08:00
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > float < B > < A HREF = "#DOC.2.126.42" > _spot_cutoff< / A > < / B >
2003-04-18 00:22:51 +08:00
< / DL > < / P >
< P > < DL >
< DT > < H3 > Protected Methods< / H3 > < DD > < DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > virtual < B > < A HREF = "#DOC.2.126.30" > ~Light< / A > < / B > ()
2003-04-18 00:22:51 +08:00
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "[more]" BORDER = 0 SRC = icon1.gif > void < B > < A HREF = "#DOC.2.126.31" > init< / A > < / B > ()
2003-04-18 00:22:51 +08:00
< DD > < I > Initialize the light's settings with some decent defaults.< / I >
< / DL > < / P >
< / DL >
< HR > < H3 > Inherited from < A HREF = "StateAttribute.html" > StateAttribute< / A > :< / H3 >
< DL >
2004-08-06 14:53:36 +08:00
< P > < DL >
< DT > < H3 > Public Classes< / H3 > < DD > < DT >
< IMG ALT = "o" SRC = icon2.gif > enum < B > Values< / B >
< DT >
< IMG ALT = "o" SRC = icon2.gif > enum < B > Types< / B >
< DT >
< IMG ALT = "o" SRC = icon2.gif > struct < B > ModeUsage< / B >
< / DL > < / P >
2003-04-18 00:22:51 +08:00
< P > < DL >
< DT > < H3 > Public Methods< / H3 > < DD > < DT >
< IMG ALT = "o" SRC = icon2.gif > virtual <!1> < A HREF = "Object.html" > Object< / A > * < B > cloneType< / B > () const
< DT >
< IMG ALT = "o" SRC = icon2.gif > virtual <!1> < A HREF = "Object.html" > Object< / A > * < B > clone< / B > (const <!1> < A HREF = "CopyOp.html" > CopyOp< / A > & ) const
< DT >
< IMG ALT = "o" SRC = icon2.gif > virtual bool < B > isSameKindAs< / B > (const <!1> < A HREF = "Object.html" > Object< / A > * obj) const
< DT >
< IMG ALT = "o" SRC = icon2.gif > virtual const char* < B > libraryName< / B > () const
< DT >
< IMG ALT = "o" SRC = icon2.gif > virtual const char* < B > className< / B > () const
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "o" SRC = icon2.gif > virtual <!1> < A HREF = "StateAttribute.html#DOC.2.229.5" > Type< / A > < B > getType< / B > () const
2003-04-18 00:22:51 +08:00
< DT >
< IMG ALT = "o" SRC = icon2.gif > virtual bool < B > isTextureAttribute< / B > () const
< DT >
< IMG ALT = "o" SRC = icon2.gif > bool < B > operator < < / B > (const <!1> < A HREF = "StateAttribute.html" > StateAttribute< / A > & rhs) const
< DT >
< IMG ALT = "o" SRC = icon2.gif > bool < B > operator == < / B > (const <!1> < A HREF = "StateAttribute.html" > StateAttribute< / A > & rhs) const
< DT >
< IMG ALT = "o" SRC = icon2.gif > bool < B > operator != < / B > (const <!1> < A HREF = "StateAttribute.html" > StateAttribute< / A > & rhs) const
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "o" SRC = icon2.gif > virtual void < B > compileGLObjects< / B > (<!1> < A HREF = "State.html" > State< / A > & ) const
< DT >
< IMG ALT = "o" SRC = icon2.gif > virtual void < B > releaseGLObjects< / B > (<!1> < A HREF = "State.html" > State< / A > * =0) const
2003-04-18 00:22:51 +08:00
< / DL > < / P >
< P > < DL >
2004-08-06 14:53:36 +08:00
< DT > < H3 > Public< / H3 > < DD > < DT >
2003-04-18 00:22:51 +08:00
< IMG ALT = "o" SRC = icon2.gif > typedef GLenum < B > GLMode< / B >
< DT >
< IMG ALT = "o" SRC = icon2.gif > typedef unsigned int < B > GLModeValue< / B >
< DT >
< IMG ALT = "o" SRC = icon2.gif > typedef unsigned int < B > OverrideValue< / B >
< DT >
< IMG ALT = "o" SRC = icon2.gif > typedef unsigned int < B > Type< / B >
< / DL > < / P >
< / DL >
< HR > < H3 > Inherited from < A HREF = "Object.html" > Object< / A > :< / H3 >
< DL >
2004-08-06 14:53:36 +08:00
< P > < DL >
< DT > < H3 > Public Classes< / H3 > < DD > < DT >
< IMG ALT = "o" SRC = icon2.gif > enum < B > DataVariance< / B >
< / DL > < / P >
2003-04-18 00:22:51 +08:00
< P > < DL >
< DT > < H3 > Public Methods< / H3 > < DD > < DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "o" SRC = icon2.gif > inline void < B > setDataVariance< / B > (<!1> < A HREF = "Object.html#DOC.2.167.8" > DataVariance< / A > dv)
2003-04-18 00:22:51 +08:00
< DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "o" SRC = icon2.gif > inline <!1> < A HREF = "Object.html#DOC.2.167.8" > DataVariance< / A > < B > getDataVariance< / B > () const
2003-04-18 00:22:51 +08:00
< DT >
< IMG ALT = "o" SRC = icon2.gif > inline void < B > setUserData< / B > (<!1> < A HREF = "Referenced.html" > Referenced< / A > * obj)
< DT >
< IMG ALT = "o" SRC = icon2.gif > inline <!1> < A HREF = "Referenced.html" > Referenced< / A > * < B > getUserData< / B > ()
< DT >
< IMG ALT = "o" SRC = icon2.gif > inline const <!1> < A HREF = "Referenced.html" > Referenced< / A > * < B > getUserData< / B > () const
< / DL > < / P >
< P > < DL >
< DT > < H3 > Protected Fields< / H3 > < DD > < DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "o" SRC = icon2.gif > <!1> < A HREF = "Object.html#DOC.2.167.8" > DataVariance< / A > < B > _dataVariance< / B >
2003-04-18 00:22:51 +08:00
< DT >
< IMG ALT = "o" SRC = icon2.gif > <!1> < A HREF = "ref_ptr.html" > ref_ptr< / A > < <!1> < A HREF = "Referenced.html" > Referenced< / A > > < B > _userData< / B >
< / DL > < / P >
< / DL >
< HR > < H3 > Inherited from < A HREF = "Referenced.html" > Referenced< / A > :< / H3 >
< DL >
< P > < DL >
< DT > < H3 > Public Methods< / H3 > < DD > < DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "o" SRC = icon2.gif > inline <!1> < A HREF = "Referenced.html" > Referenced< / A > & < B > operator = < / B > (const <!1> < A HREF = "Referenced.html" > Referenced< / A > & )
2003-04-18 00:22:51 +08:00
< DT >
< IMG ALT = "o" SRC = icon2.gif > static void < B > setDeleteHandler< / B > (<!1> < A HREF = "DeleteHandler.html" > DeleteHandler< / A > * handler)
< DT >
< IMG ALT = "o" SRC = icon2.gif > static <!1> < A HREF = "DeleteHandler.html" > DeleteHandler< / A > * < B > getDeleteHandler< / B > ()
< DT >
< IMG ALT = "o" SRC = icon2.gif > inline void < B > ref< / B > () const
< DT >
< IMG ALT = "o" SRC = icon2.gif > inline void < B > unref_nodelete< / B > () const
< DT >
< IMG ALT = "o" SRC = icon2.gif > inline int < B > referenceCount< / B > () const
< DT >
< IMG ALT = "o" SRC = icon2.gif > inline void < B > unref< / B > () const
< / DL > < / P >
< P > < DL >
< DT > < H3 > Protected Fields< / H3 > < DD > < DT >
2004-08-06 14:53:36 +08:00
< IMG ALT = "o" SRC = icon2.gif > mutable OpenThreads::Mutex < B > _refMutex< / B >
< DT >
2003-04-18 00:22:51 +08:00
< IMG ALT = "o" SRC = icon2.gif > mutable int < B > _refCount< / B >
< / DL > < / P >
< / DL >
< A NAME = "DOC.DOCU" > < / A >
< HR >
< H2 > Documentation< / H2 >
< BLOCKQUOTE > Light state class which encapsulates OpenGL glLight() functionality< / BLOCKQUOTE >
< DL >
< A NAME = "Light" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.1" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > Light()< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "Light" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.2" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > Light(const <!1> < A HREF = "Light.html#DOC.2.126.2" > Light< / A > & light, const <!1> < A HREF = "CopyOp.html" > CopyOp< / A > & copyop=CopyOp::SHALLOW_COPY)< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > Copy constructor using CopyOp to manage deep vs shallow copy
< DL > < DT > < DD > < / DL > < P >
< A NAME = "META_StateAttribute" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.3" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > META_StateAttribute(<!1> < A HREF = "osg.html" > osg< / A > , <!1> < A HREF = "Light.html" > Light< / A > , (<!1> < A HREF = "StateAttribute.html#DOC.2.229.5" > Type< / A > )(<!1> < A HREF = "StateAttribute.html#DOC.2.229.6.12" > LIGHT_0< / A > +<!1> < A HREF = "Light.html#DOC.2.126.32" > _lightnum< / A > ))< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DL > < DT > < DD > < / DL > < P >
< A NAME = "compare" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.4" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > virtual int compare(const <!1> < A HREF = "StateAttribute.html" > StateAttribute< / A > & sa) const < / B > < / TT >
< DD > return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs
< DL > < DT > < DD > < / DL > < P >
2004-08-06 14:53:36 +08:00
< A NAME = "getModeUsage" > < / A >
< A NAME = "DOC.2.126.5" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > virtual bool getModeUsage(<!1> < A HREF = "StateAttribute.html#DOC.2.229.20" > ModeUsage< / A > & usage) const < / B > < / TT >
2003-04-18 00:22:51 +08:00
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setLightNum" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.6" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > void setLightNum(int num)< / B > < / TT >
< DD > Set which OpenGL light to operate on
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getLightNum" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.7" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > int getLightNum() const < / B > < / TT >
< DD > Get which OpenGL light this osg::Light operates on
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setAmbient" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.8" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void setAmbient( const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & ambient )< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > Set the ambient component of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getAmbient" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.9" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & getAmbient() const < / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > Get the ambient component of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setDiffuse" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.10" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void setDiffuse( const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & diffuse )< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > Set the diffuse component of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getDiffuse" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.11" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & getDiffuse() const < / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > Get the diffuse component of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setSpecular" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.12" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void setSpecular( const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & specular )< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > Set the specular component of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getSpecular" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.13" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & getSpecular() const < / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > Get the specular component of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setPosition" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.14" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void setPosition( const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & position )< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > Set the position of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getPosition" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.15" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline const <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > & getPosition() const < / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > Get the position of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setDirection" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.16" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void setDirection( const <!1> < A HREF = "osg.html#DOC.2.262" > Vec3< / A > & direction )< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > Set the direction of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getDirection" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.17" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline const <!1> < A HREF = "osg.html#DOC.2.262" > Vec3< / A > & getDirection() const < / B > < / TT >
2003-04-18 00:22:51 +08:00
< DD > Get the direction of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setConstantAttenuation" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.18" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void setConstantAttenuation( float constant_attenuation )< / B > < / TT >
< DD > Set the constant attenuation of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getConstantAttenuation" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.19" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline float getConstantAttenuation() const < / B > < / TT >
< DD > Get the constant attenuation of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setLinearAttenuation" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.20" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void setLinearAttenuation( float linear_attenuation )< / B > < / TT >
< DD > Set the linear attenuation of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getLinearAttenuation" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.21" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline float getLinearAttenuation() const < / B > < / TT >
< DD > Get the linear attenuation of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setQuadraticAttenuation" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.22" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void setQuadraticAttenuation( float quadratic_attenuation )< / B > < / TT >
< DD > Set the quadratic attenuation of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getQuadraticAttenuation" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.23" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline float getQuadraticAttenuation() const < / B > < / TT >
< DD > Get the quadratic attenuation of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setSpotExponent" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.24" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void setSpotExponent( float spot_exponent )< / B > < / TT >
< DD > Set the spot exponent of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getSpotExponent" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.25" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline float getSpotExponent() const < / B > < / TT >
< DD > Get the spot exponent of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "setSpotCutoff" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.26" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline void setSpotCutoff( float spot_cutoff )< / B > < / TT >
< DD > Set the spot cutoff of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "getSpotCutoff" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.27" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > inline float getSpotCutoff() const < / B > < / TT >
< DD > Get the spot cutoff of the light.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "captureLightState" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.28" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > void captureLightState()< / B > < / TT >
< DD >
Capture the lighting settings of the current OpenGL state
and store them in this object
< DL > < DT > < DD > < / DL > < P >
< A NAME = "apply" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.29" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > virtual void apply(<!1> < A HREF = "State.html" > State< / A > & state) const < / B > < / TT >
< DD > Apply the light's state to the OpenGL state machine.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "~Light" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.30" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > virtual ~Light()< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "init" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.31" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > void init()< / B > < / TT >
< DD > Initialize the light's settings with some decent defaults.
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_lightnum" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.32" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > int _lightnum< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_ambient" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.33" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > _ambient< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_diffuse" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.34" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > _diffuse< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_specular" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.35" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > _specular< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_position" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.36" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > <!1> < A HREF = "osg.html#DOC.2.270" > Vec4< / A > _position< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_direction" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.37" > < / A >
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > <!1> < A HREF = "osg.html#DOC.2.262" > Vec3< / A > _direction< / B > < / TT >
2003-04-18 00:22:51 +08:00
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_constant_attenuation" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.38" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > float _constant_attenuation< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_linear_attenuation" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.39" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > float _linear_attenuation< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_quadratic_attenuation" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.40" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > float _quadratic_attenuation< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_spot_exponent" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.41" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > float _spot_exponent< / B > < / TT >
< DL > < DT > < DD > < / DL > < P >
< A NAME = "_spot_cutoff" > < / A >
2004-08-06 14:53:36 +08:00
< A NAME = "DOC.2.126.42" > < / A >
2003-04-18 00:22:51 +08:00
< DT > < IMG ALT = "o" BORDER = 0 SRC = icon2.gif > < TT > < B > float _spot_cutoff< / B > < / TT >
< DL > < DT > < DD > < / DL > < P > < / DL >
< HR > < DL > < DT > < B > This class has no child classes.< / B > < / DL >
< DL > < DT > < DD > < / DL > < P > < P > < I > < A HREF = "index.html" > Alphabetic index< / A > < / I > < I > < A HREF = "HIER.html" > HTML hierarchy of classes< / A > or < A HREF = "HIERjava.html" > Java< / A > < / I > < / P > < HR >
< BR >
2004-08-06 14:53:36 +08:00
This page was generated with the help of < A HREF = "http://www.linuxsupportline.com/~doc++" > DOC++< / A > .
2003-04-18 00:22:51 +08:00
< / BODY >
< / HTML >
