chai3d::cSpotLight Class Reference

This class implements a spot light source. More...

#include <CSpotLight.h>

Inheritance diagram for chai3d::cSpotLight:

Public Member Functions

 cSpotLight (cWorld *a_world)
 Constructor of cSpotLight. More...
 
virtual ~cSpotLight ()
 Destructor of cSpotLight. More...
 
bool updateShadowMap (const double a_mirrorH=1.0, const double a_mirrorV=1.0)
 This method updates the shadow map. More...
 
void setShadowMapProperties (const double &a_nearClippingPlane, const double &a_farClippingPlane)
 This method define the near and far clipping planes of the shadow map. More...
 
void setShadowMapEnabled (const bool a_enabled)
 This method enables of disables the shadow map. More...
 
bool getShadowMapEnabled () const
 This method returns true if the shadow map is enabled, false otherwise. More...
 
void setSpotExponent (const GLfloat &a_value)
 This method sets the concentration level of the light (0.0 - 100.0). More...
 
GLfloat getSpotExponent () const
 This method returns the concentration level of the light. More...
 
void setCutOffAngleDeg (const GLfloat &a_angleDeg)
 This method sets the cutoff angle in degrees (only affects spotlights) (positional lights with angular cutoffs). More...
 
GLfloat getCutOffAngleDeg () const
 This method returns the cut off angle. More...
 
void setDisplaySettings (const double &a_sourceRadius=0.02, const double &a_coneLength=1.0, const bool a_displayEnabled=true)
 This method sets the display settings of light source. To be used for debugging purposes to display location and direction of light source. More...
 
- Public Member Functions inherited from chai3d::cPositionalLight
 cPositionalLight (cWorld *a_world)
 Constructor of cPositionalLight. More...
 
virtual ~cPositionalLight ()
 Destructor of cPositionalLight. More...
 
void setAttConstant (const GLfloat &a_value)
 This method sets the constant attenuation parameter. More...
 
GLfloat getAttConstant () const
 This method returns the constant attenuation parameter. More...
 
void setAttLinear (const GLfloat &a_value)
 This method sets the linear attenuation parameter. More...
 
GLfloat getAttLinear () const
 This method returns the linear attenuation parameter. More...
 
void setAttQuadratic (const GLfloat &a_value)
 This method set the quadratic attenuation parameter. More...
 
GLfloat getAttQuadratic () const
 This method returns the quadratic attenuation parameter. More...
 
void setDisplaySettings (const double &a_sourceRadius=0.02, const bool a_displayEnabled=true)
 This method sets the display settings of this light source. (To be used for debugging purposes to display location of light source.) More...
 
- Public Member Functions inherited from chai3d::cGenericLight
 cGenericLight (cWorld *a_world)
 Constructor of cGenericLight. More...
 
virtual ~cGenericLight ()
 Destructor of cGenericLight. More...
 
void setUseTwoSideLightModel (bool a_useTwoSideLightModel)
 This method enables or disables the two sided lighting mode. More...
 
bool getUseTwoSideLightModel () const
 This method returns true if the two sided lighting mode is enabled, false otherwise. More...
 
void setDisplayEnabled (bool a_enabled)
 This method enables or disables the graphic representation of light source. (To be used for debugging purposes). More...
 
bool getDisplayEnabled () const
 This method returns true of graphic display representation of the light source is enabled, false otherwise. More...
 
void setGLLightNumber (const GLint a_glLightNumber)
 This method sets the OpenGL Light ID number. Assigning these numbers is normally handled by the world in which the light source is located. More...
 
GLint getGLLightNumber () const
 This method returns the OpenGL Light ID number for this light source. More...
 
- Public Member Functions inherited from chai3d::cGenericObject
 cGenericObject ()
 Constructor of cGenericObject. More...
 
virtual ~cGenericObject ()
 Destructor of cGenericObject. More...
 
virtual void setEnabled (bool a_enabled, const bool a_affectChildren=false)
 This method enables or disable this object. When an object is disabled, both haptic and graphic rendering no longer occur. More...
 
bool getEnabled () const
 This method returns true if the object is enabled, false otherwise. More...
 
virtual cGenericObjectcopy (const bool a_duplicateMaterialData=false, const bool a_duplicateTextureData=false, const bool a_duplicateMeshData=false, const bool a_buildCollisionDetector=true)
 This method creates a copy of itself. More...
 
virtual void setLocalPos (const cVector3d &a_localPos)
 This method sets the local position of this object. More...
 
void setLocalPos (const double a_x=0.0, const double a_y=0.0, const double a_z=0.0)
 This method sets the local position of this object. More...
 
cVector3d getLocalPos () const
 This method returns the local position of this object. More...
 
cVector3d getGlobalPos () const
 This method returns the global position of this object. More...
 
virtual void setLocalRot (const cMatrix3d &a_localRot)
 This method sets the local rotation matrix for this object. More...
 
cMatrix3d getLocalRot () const
 This method returns the local rotation matrix of this object. More...
 
cMatrix3d getGlobalRot () const
 This method returns the global rotation matrix of this object. More...
 
void setLocalTransform (const cTransform &a_transform)
 This method returns the local position and rotation matrix by passing a transformation matrix. More...
 
cTransform getLocalTransform ()
 This method returns the local position and rotation matrix in a transformation matrix. More...
 
cTransform getGlobalTransform ()
 This method returns the global position and rotation matrix in a transformation matrix. More...
 
void translate (const cVector3d &a_translation)
 This method translates this object by a specified offset. More...
 
void translate (const double a_x, const double a_y, const double a_z=0.0)
 This method translates this object by a specified offset. More...
 
void rotateAboutLocalAxisRad (const cVector3d &a_axis, const double a_angleRad)
 This method rotates this object around a local axis. Angle magnitude is defined in radians. More...
 
void rotateAboutLocalAxisDeg (const cVector3d &a_axis, const double a_angleDeg)
 This method rotates this object around a local axis. Angle magnitude is defined in degrees. More...
 
void rotateAboutLocalAxisRad (const double a_axisX, const double a_axisY, const double a_axisZ, const double a_angleRad)
 This method rotates this object around a local axis. Angle magnitude is defined in radians. More...
 
void rotateAboutLocalAxisDeg (const double a_axisX, const double a_axisY, const double a_axisZ, const double a_angleDeg)
 This method rotates this object around a local axis. Angle magnitude is defined in degrees. More...
 
void rotateAboutGlobalAxisRad (const cVector3d &a_axis, const double a_angleRad)
 This method rotates this object around a global axis. Angle magnitude is defined in radians. More...
 
void rotateAboutGlobalAxisDeg (const cVector3d &a_axis, const double a_angleDeg)
 This method rotates this object around a global axis. Angle magnitude is defined in degrees. More...
 
void rotateAboutGlobalAxisRad (const double a_axisX, const double a_axisY, const double a_axisZ, const double a_angleRad)
 This method rotate this object around a local axis. Angle magnitude is defined in radians. More...
 
void rotateAboutGlobalAxisDeg (const double a_axisX, const double a_axisY, const double a_axisZ, const double a_angleDeg)
 This method rotates this object around a local axis. Angle magnitude is defined in degrees. More...
 
void rotateExtrinsicEulerAnglesRad (const double &a_angleRad1, const double &a_angleRad2, const double &a_angleRad3, const cEulerOrder a_eulerOrder)
 This method rotates this object using fixed Euler representation. Angles are defined in radians. More...
 
void rotateExtrinsicEulerAnglesDeg (const double &a_angleDeg1, const double &a_angleDeg2, const double &a_angleDeg3, const cEulerOrder a_eulerOrder)
 This method rotates this object using fixed Euler representation. Angles are defined in radians. More...
 
void rotateIntrinsicEulerAnglesRad (const double &a_angleRad1, const double &a_angleRad2, const double &a_angleRad3, const cEulerOrder a_eulerOrder)
 This method rotates this object using co-moving Euler representation. Angles are defined in radians. More...
 
void rotateIntrinsicEulerAnglesDeg (const double &a_angleDeg1, const double &a_angleDeg2, const double &a_angleDeg3, const cEulerOrder a_eulerOrder)
 This method rotates this object using co-moving Euler representation. Angles are defined in radians. More...
 
virtual void computeGlobalPositions (const bool a_frameOnly=true, const cVector3d &a_globalPos=cVector3d(0.0, 0.0, 0.0), const cMatrix3d &a_globalRot=cIdentity3d())
 This method computes the global position and rotation of this object and its children. More...
 
void computeGlobalPositionsFromRoot (const bool a_frameOnly=true)
 This method computes the global position and rotation of current object only. More...
 
bool addEffect (cGenericEffect *a_effect)
 This method adds a haptic effect to this object. More...
 
bool removeEffect (cGenericEffect *a_effect)
 This method removes a haptic effect from this object. More...
 
void deleteAllEffects ()
 This method removes all haptic effects. More...
 
bool createEffectMagnetic ()
 This method creates a magnetic haptic effect. More...
 
bool deleteEffectMagnetic ()
 This method deletes any current magnetic haptic effect. More...
 
bool createEffectStickSlip ()
 This method creates a stick-and-slip haptic effect. More...
 
bool deleteEffectStickSlip ()
 This method delete any current stick-and-slip haptic effect. More...
 
bool createEffectSurface ()
 This method creates a surface haptic effect. More...
 
bool deleteEffectSurface ()
 This method deletes any current surface haptic effect. More...
 
bool createEffectVibration ()
 This method creates a vibration haptic effect. More...
 
bool deleteEffectVibration ()
 This method deletes any current vibration haptic effect. More...
 
bool createEffectViscosity ()
 This method creates a viscous haptic effect. More...
 
bool deleteEffectViscosity ()
 This method deletes any current viscous haptic effect. More...
 
virtual void setHapticEnabled (const bool a_hapticEnabled, const bool a_affectChildren=true)
 This method enables or disables haptic perception of this object, optionally propagating the change to children. More...
 
bool getHapticEnabled () const
 This method returns the haptic status of object (true means it can be felt when visible). More...
 
virtual void setStiffness (const double a_stiffness, const bool a_affectChildren=true)
 This method sets the haptic stiffness of the object, optionally recursively affecting children. More...
 
virtual void setFriction (double a_staticFriction, double a_dynamicFriction, const bool a_affectChildren=true)
 This method sets the static and dynamic friction properties (polygonal models only), optionally recursively affecting children. More...
 
virtual void setShowEnabled (const bool a_show, const bool a_affectChildren=true)
 This method enables or disables the graphic display of this object, optionally propagating the change to children. More...
 
bool getShowEnabled () const
 This method returns the display status of object (true means it's visible). More...
 
virtual void setWireMode (const bool a_showWireMode, const bool a_affectChildren=false)
 This method enables or disables wireframe rendering, optionally propagating the operation to my children. More...
 
bool getWireMode () const
 This method returns whether wireframe rendering is enabled. More...
 
virtual void setUseCulling (const bool a_useCulling, const bool a_affectChildren=false)
 This method enables or disables face-culling, optionally propagating the operation to my children. More...
 
bool getUseCulling () const
 This method returns true if face-culling is enabled, false otherwise. More...
 
virtual void setUseTransparency (const bool a_useTransparency, const bool a_affectChildren=false)
 This method enables or disables transparency. More...
 
bool getUseTransparency () const
 This method returns true if transparency is enabled, false otherwise. More...
 
virtual void setTransparencyLevel (const float a_level, const bool a_applyToVertices=false, const bool a_applyToTextures=false, const bool a_affectChildren=false)
 This method sets the transparency level of the object. More...
 
virtual void setUseDisplayList (const bool a_useDisplayList, const bool a_affectChildren=false)
 This method enabled or disables the use of a display list for rendering, optionally propagating the operation to its children. More...
 
bool getUseDisplayList () const
 This method returns true if a display list is activated, false otherwise. More...
 
virtual void markForUpdate (const bool a_affectChildren=false)
 This method invalidates any existing display lists, optionally propagating the operation to its children. More...
 
virtual void setUseVertexColors (const bool a_useColors, const bool a_affectChildren=false)
 This method enables or disables the use of per-vertex colors, optionally propagating the operation to its children. More...
 
bool getUseVertexColors () const
 This method returns true is per-vertex color properties are enabled, false otherwise. More...
 
virtual void setUseMaterial (const bool a_useMaterial, const bool a_affectChildren=false)
 This method enables or disables the use of material properties, optionally propagating the operation to its children. More...
 
bool getUseMaterial () const
 This method returns true is material properties are enabled, false otherwise. More...
 
virtual void setMaterial (cMaterialPtr a_material, const bool a_affectChildren=false)
 This method sets the material properties of this object, optionally propagating the operation to its children. More...
 
virtual void setMaterial (cMaterial &a_material, const bool a_affectChildren=false)
 This method setd the material properties of this object, optionally propagating the operation to its children. More...
 
virtual void backupMaterialColors (const bool a_affectChildren=false)
 This method creates a backup of the material colors of this object, optionally propagating the operation to its children. More...
 
virtual void restoreMaterialColors (const bool a_affectChildren=false)
 This method restores the material color properties of this object from a previous backup, optionally propagating the operation to its children. More...
 
virtual void setUseTexture (const bool a_useTexture, const bool a_affectChildren=false)
 This method enables or disables the use of texture-mapping, optionally propagating the operation to its children. More...
 
bool getUseTexture () const
 This method returns true if texture-mapping is enabled, false otherwise. More...
 
virtual void setTexture (cTexture1dPtr a_texture, const bool a_affectChildren=false)
 This method sets a texture to this object, optionally propagating the operation to its children. More...
 
virtual void setShaderProgram (cShaderProgramPtr a_shaderProgram, const bool a_affectChildren=false)
 This method assigns a shader program to this object, optionally propagating the operation to its children.. More...
 
virtual cShaderProgramPtr getShaderProgram ()
 This method returns a pointer to the current shader program. More...
 
virtual void setShowBoundaryBox (const bool a_showBoundaryBox, const bool a_affectChildren=false)
 This method enables or disabled the graphic display of the boundary box for this object, optionally propagating the change to its children. More...
 
bool getShowBoundaryBox () const
 This method returns true if the boundary box is being displayed, false otherwise. More...
 
cVector3d getBoundaryMin () const
 This method returns the minimum point of this object's boundary box. More...
 
cVector3d getBoundaryMax () const
 This method returns the maximum point of this object's boundary box. More...
 
cVector3d getBoundaryCenter () const
 This method computes and returns the center of this object's boundary box. More...
 
bool getBoundaryBoxEmpty ()
 This method returns true, if the boundary box is empty, otherwise false. More...
 
virtual void computeBoundaryBox (const bool a_includeChildren=true)
 This method computes this object's boundary box, optionally forcing it to bound child objects. More...
 
virtual void setShowFrame (const bool a_showFrame, const bool a_affectChildren=false)
 This method enables or disables the graphic display of the reference frame arrows for this object, optionally propagating the change to its children. More...
 
bool getShowFrame (void) const
 This method returns true if the display of the reference frame is enabled, false otherwise. More...
 
virtual void setFrameSize (const double a_size=1.0, const bool a_affectChildren=false)
 This method sets the size of the rendered reference frame, optionally propagating the change to its children. More...
 
double getFrameSize () const
 This method returns the size of the graphical reference frame. More...
 
void setCollisionDetector (cGenericCollision *a_collisionDetector)
 This method sets a collision detector to this current object. More...
 
cGenericCollisiongetCollisionDetector () const
 This method returns a pointer to this object's current collision detector. More...
 
virtual void deleteCollisionDetector (const bool a_affectChildren=false)
 This method deletes any existing collision detector. More...
 
virtual bool computeCollisionDetection (const cVector3d &a_segmentPointA, const cVector3d &a_segmentPointB, cCollisionRecorder &a_recorder, cCollisionSettings &a_settings)
 This method computes any collision between a segment and this object. More...
 
virtual void setShowCollisionDetector (const bool a_showCollisionDetector, const bool a_affectChildren=false)
 This method enables or disables the display of the collision detector, optionally propagating the change to its children. More...
 
bool getShowCollisionDetector ()
 This method returns true if the collision detector is being displayed graphically, false otherwise. More...
 
virtual void setCollisionDetectorProperties (unsigned int a_displayDepth, cColorf &a_color, const bool a_affectChildren=false)
 This method sets the collision detector graphic display properties. More...
 
void setParent (cGenericObject *a_parent)
 This method sets the parent of this object. More...
 
cGenericObjectgetParent () const
 This method returns the parent of this object. More...
 
void setOwner (cGenericObject *a_owner)
 This method sets a link to an object that owns this object. This could be a super parent for instance. More...
 
cGenericObjectgetOwner ()
 This method returns the owner of this object. More...
 
cGenericObjectgetChild (const unsigned int a_index) const
 This method returns a selected child from the list of children. More...
 
bool addChild (cGenericObject *a_object)
 This method add an object to the list of children. More...
 
bool removeChild (cGenericObject *a_object)
 This method removes an object from the list of children, without deleting it. More...
 
bool removeFromGraph ()
 This method removes this object from its parent's list of children. More...
 
bool deleteChild (cGenericObject *a_object)
 This method removes an object from its list of children and deletes it. More...
 
void clearAllChildren ()
 This method clears all objects from its list of children, without deleting them. More...
 
void deleteAllChildren ()
 This method clears and delete all objects from its list of children. More...
 
unsigned int getNumChildren ()
 This method returns the number of children from its list of children. More...
 
unsigned int getNumDescendants (bool a_includeCurrentObject=false)
 This method returns the total number of descendants, optionally including this object. More...
 
void setGhostEnabled (bool a_ghostEnabled)
 This method enables or disables this object to be a ghost node. More...
 
bool getGhostEnabled ()
 This method returns truee if this object is a ghost node. More...
 
virtual void scale (const double &a_scaleFactor, const bool a_affectChildren=true)
 This method scales the size of this object. More...
 
virtual void renderSceneGraph (cRenderOptions &a_options)
 This method renders the entire scene graph, starting from this object. More...
 
virtual void adjustCollisionSegment (cVector3d &a_segmentPointA, cVector3d &a_segmentPointAadjusted)
 This method adjusts the collision segment to handle objects in motion. More...
 
virtual cVector3d computeInteractions (const cVector3d &a_toolPos, const cVector3d &a_toolVel, const unsigned int a_IDN, cInteractionRecorder &a_interactions)
 This method computes all haptic interaction between a tool and this object using the haptic effects. More...
 
- Public Member Functions inherited from chai3d::cGenericType
 cGenericType ()
 Constructor of cGenericType. More...
 
virtual ~cGenericType ()
 Destructor of cGenericType. More...
 
- Public Member Functions inherited from chai3d::cDirectionalLight
 cDirectionalLight (cWorld *a_world)
 Constructor of cDirectionalLight. More...
 
virtual ~cDirectionalLight ()
 Destructor of cDirectionalLight. More...
 
void setDir (const cVector3d &a_direction)
 This method sets the direction of the light beam. More...
 
void setDir (const double a_x, const double a_y, const double a_z)
 This method sets the direction of the light beam. More...
 
cVector3d getDir () const
 This method returns the direction of the light beam. More...
 

Public Attributes

cShadowMapm_shadowMap
 Shadow map. More...
 
cColorf m_displayConeColor
 Color used for rendering the light cone of the display model. More...
 
- Public Attributes inherited from chai3d::cPositionalLight
cColorf m_displaySourceColor
 Color used for rendering the display model of the light source. More...
 
- Public Attributes inherited from chai3d::cGenericLight
cColorf m_ambient
 Ambient light component. More...
 
cColorf m_diffuse
 Diffuse light component. More...
 
cColorf m_specular
 Specular light component. More...
 
- Public Attributes inherited from chai3d::cGenericObject
std::string m_name
 Name of current object (filename). More...
 
cMaterialPtr m_material
 Material property. More...
 
cTexture1dPtr m_texture
 Texture property. More...
 
cNormalMapPtr m_normalMap
 Normal map property. More...
 
int m_userTag
 An arbitrary tag, not used by CHAI3D. More...
 
void * m_userData
 An arbitrary data pointer, not used by CHAI3D. More...
 
std::string m_userName
 Name of current object, not used by CHAI3D. More...
 
cGenericObjectm_userExternalObject
 A link to an external cGenericObject object, not used by CHAI3D. More...
 
cVector3d m_interactionPoint
 Projection of the most recent haptic point (tool) onto the surface of the virtual object. More...
 
cVector3d m_interactionNormal
 Surface normal at the current interaction point. More...
 
bool m_interactionInside
 Was the last tool (haptic point) located inside the object? More...
 

Protected Member Functions

virtual void renderLightSource (cRenderOptions &a_options)
 This method renders the lighting properties of this light source in OpenGL. More...
 
virtual void render (cRenderOptions &a_options)
 This method renders a graphical representation (display model) of the light source. (used for debuging purposes typically). More...
 
- Protected Member Functions inherited from chai3d::cGenericObject
virtual void updateGlobalPositions (const bool a_frameOnly)
 This method update the global position information about this object. More...
 
virtual void updateBoundaryBox ()
 This method updates the boundary box of this object. More...
 
virtual void scaleObject (const double &a_scaleFactor)
 This method scales the size of this object with given scale factor. More...
 
virtual void computeLocalInteraction (const cVector3d &a_toolPos, const cVector3d &a_toolVel, const unsigned int a_IDN)
 This method updates the geometric relationship between the tool and the current object. More...
 
virtual cVector3d computeOtherInteractions (const cVector3d &a_toolPos, const cVector3d &a_toolVel, const unsigned int a_IDN, cInteractionRecorder &a_interactions)
 This method computes any additional interactions between the object and the tools. More...
 
virtual bool computeOtherCollisionDetection (cVector3d &a_segmentPointA, cVector3d &a_segmentPointB, cCollisionRecorder &a_recorder, cCollisionSettings &a_settings)
 This method computes any additional collisions other than the ones computed by the default collision detector. More...
 
void copyGenericObjectProperties (cGenericObject *a_objDest, const bool a_duplicateMaterialData, const bool a_duplicateTextureData, const bool a_duplicateMeshData, const bool a_buildCollisionDetector)
 This method copies all properties of the current generic object to another. More...
 

Protected Attributes

GLfloat m_spotExponent
 Concentration of the light. More...
 
GLfloat m_cutOffAngleDeg
 Cut off angle (for spot lights only). Only values in the range 0 to 90 degrees. More...
 
double m_shadowNearClippingPlane
 Shadow map near clipping plane. More...
 
double m_shadowFarClippingPlane
 Shadow map far clipping plane. More...
 
double m_displayConeLength
 Length of light cone for display model. More...
 
- Protected Attributes inherited from chai3d::cPositionalLight
GLfloat m_attConstant
 Constant attenuation parameter. More...
 
GLfloat m_attLinear
 Linear attenuation parameter. More...
 
GLfloat m_attQuadratic
 Quadratic attenuation parameter. More...
 
double m_displaySourceRadius
 Radius of display model representing light source. More...
 
- Protected Attributes inherited from chai3d::cGenericLight
cWorldm_worldParent
 Parent world in which light source is located. More...
 
GLint m_glLightNumber
 OpenGL reference number for the current light source. This number ranges from 0 to 7. More...
 
GLint m_useTwoSideLightModel
 If true then a two sided light source model is used. More...
 
bool m_displayEnabled
 If true then a graphical representation of the light source is rendered. More...
 
- Protected Attributes inherited from chai3d::cGenericObject
cGenericObjectm_parent
 Parent object. More...
 
cGenericObjectm_owner
 
std::vector< cGenericObject * > m_children
 List of children. More...
 
cVector3d m_localPos
 The position of this object in my parent's reference frame. More...
 
cVector3d m_globalPos
 The position of this object in the world's reference frame. More...
 
cMatrix3d m_localRot
 The rotation matrix that rotates my reference frame into my parent's reference frame. More...
 
cMatrix3d m_globalRot
 The rotation matrix that rotates my reference frame into the world's reference frame. More...
 
cVector3d m_prevGlobalPos
 Previous position since last haptic computation. More...
 
cMatrix3d m_prevGlobalRot
 Previous rotation since last haptic computation. More...
 
cVector3d m_boundaryBoxMin
 Minimum position of boundary box. More...
 
cVector3d m_boundaryBoxMax
 Maximum position of boundary box. More...
 
bool m_boundaryBoxEmpty
 If true, then the boundary box does not include any object. More...
 
double m_frameSize
 Size of graphical representation of frame (X-Y-Z). More...
 
double m_frameThicknessScale
 Pen thickness of graphical representation of frame (X-Y-Z). More...
 
bool m_enabled
 If true, the object may be rendered graphically and haptically. More...
 
bool m_showEnabled
 If true, this object is rendered. More...
 
bool m_hapticEnabled
 If true, this object can be felt. More...
 
bool m_ghostEnabled
 If true, object is enabled as ghost. More...
 
bool m_showFrame
 If true, this object's reference frame is rendered as a set of arrows. More...
 
bool m_showBoundaryBox
 If true, this object's boundary box is displayed as a set of lines. More...
 
bool m_showCollisionDetector
 If true, the collision detector is displayed (if available) at this node. More...
 
bool m_useTextureMapping
 Should texture mapping be used? More...
 
bool m_useMaterialProperty
 Should material properties be used? More...
 
bool m_useVertexColors
 Should per-vertex colors be used? More...
 
bool m_useDisplayList
 Should we use a display list to render this mesh? More...
 
cDisplayList m_displayList
 Basic display list for current object. More...
 
int m_triangleMode
 The polygon rendering mode (GL_FILL or GL_LINE). More...
 
bool m_useTransparency
 
bool m_cullingEnabled
 
cShaderProgramPtr m_shaderProgram
 Shader program. More...
 
cTransform m_frameGL
 OpenGL matrix describing my position and orientation transformation. More...
 
cGenericCollisionm_collisionDetector
 The collision detector used to test for contact with this object. More...
 
std::vector< cGenericEffect * > m_effects
 List of haptic effects programmed for this object. More...
 

Additional Inherited Members

- Static Public Attributes inherited from chai3d::cGenericObject
static cColorf s_boundaryBoxColor
 Color of the boundary box. More...
 
- Static Protected Attributes inherited from chai3d::cGenericObject
static cMaterialPtr s_defaultMaterial = nullptr
 Default material property. More...
 

Detailed Description

This class implements a spot light source.

Constructor & Destructor Documentation

chai3d::cSpotLight::cSpotLight ( cWorld a_world)

Constructor of cSpotLight.

Parameters
a_worldParent world in which the light source is created.
chai3d::cSpotLight::~cSpotLight ( )
virtual

Destructor of cSpotLight.

Member Function Documentation

bool chai3d::cSpotLight::updateShadowMap ( const double  a_mirrorH = 1.0,
const double  a_mirrorV = 1.0 
)

This method updates the shadow map for this light source.

Parameters
a_mirrorHHorizontal mirror scale factor (-1.0 or 1.0).
a_mirrorVVertical mirror scale factor (-1.0 or 1.0).
Returns
true if operation succeeded, __false__otherwise.
void chai3d::cSpotLight::setShadowMapProperties ( const double &  a_nearClippingPlane,
const double &  a_farClippingPlane 
)

This method defines the near and far clipping planes of the shadow map For optimal quality rendering, it is important to set the values accordingly to the size of the environment.

Parameters
a_nearClippingPlaneNear clipping plane of shadow.
a_farClippingPlaneFar clipping plane of shadow.
void chai3d::cSpotLight::setShadowMapEnabled ( const bool  a_enabled)

This method enables or disables the shadow map for current spot light.

Parameters
a_enabledShadow map status.
bool chai3d::cSpotLight::getShadowMapEnabled ( ) const

This method returns the status of current shadow map.

Returns
true if the shadow map is enabled, false otherwise.
void chai3d::cSpotLight::setSpotExponent ( const GLfloat &  a_value)
inline
GLfloat chai3d::cSpotLight::getSpotExponent ( ) const
inline
void chai3d::cSpotLight::setCutOffAngleDeg ( const GLfloat &  a_angleDeg)

This method sets the cutoff angle (in degrees) of the light beam. Accepted values range from 0 to 90 degrees for spot lights.

Parameters
a_angleDegCutoff angle of light beam in degrees.
GLfloat chai3d::cSpotLight::getCutOffAngleDeg ( ) const
inline
void chai3d::cSpotLight::setDisplaySettings ( const double &  a_sourceRadius = 0.02,
const double &  a_coneLength = 1.0,
const bool  a_displayEnabled = true 
)

This method sets the display settings of light source. To be used for debugging purposes to display location and direction of light source.

Parameters
a_sourceRadiusRadius of displayed light source.
a_coneLengthLength of cone light.
a_displayEnabledDisplay status.
void chai3d::cSpotLight::renderLightSource ( cRenderOptions a_options)
protectedvirtual

This method renderss this light source in OpenGL. Do not call this method directly.

Parameters
a_optionsRendering options.

Reimplemented from chai3d::cDirectionalLight.

void chai3d::cSpotLight::render ( cRenderOptions a_options)
protectedvirtual

This method renders a graphic representation of the light spot in OpenGL. This is used for debugging purposes when one wants to display the cone illuminated by the light.

Parameters
a_optionsRendering options.

Reimplemented from chai3d::cDirectionalLight.

Member Data Documentation

cShadowMap* chai3d::cSpotLight::m_shadowMap
cColorf chai3d::cSpotLight::m_displayConeColor
GLfloat chai3d::cSpotLight::m_spotExponent
protected
GLfloat chai3d::cSpotLight::m_cutOffAngleDeg
protected
double chai3d::cSpotLight::m_shadowNearClippingPlane
protected
double chai3d::cSpotLight::m_shadowFarClippingPlane
protected
double chai3d::cSpotLight::m_displayConeLength
protected

The documentation for this class was generated from the following files: