OGRE  1.12.7
Object-Oriented Graphics Rendering Engine
Ogre::PCZLight Class Reference

Specialized version of Ogre::Light which caches which zones the light affects. More...

#include <OgrePCZLight.h>

+ Inheritance diagram for Ogre::PCZLight:

Public Member Functions

 PCZLight ()
 Default constructor (for Python mainly). More...
 
 PCZLight (const String &name)
 Normal constructor. More...
 
 ~PCZLight ()
 Standard destructor. More...
 
virtual void _notifyMoved (void)
 MovableObject notified when SceneNode changes. More...
 
void addZoneToAffectedZonesList (PCZone *zone)
 Manually add a zone to the zones affected list. More...
 
bool affectsVisibleZone (void)
 
bool affectsZone (PCZone *zone)
 Check if a zone is in the list of zones affected by the light. More...
 
void clearAffectedZones (void)
 Clear the affectedZonesList. More...
 
void clearNeedsUpdate (void)
 Clear update flag. More...
 
const StringgetMovableType (void) const
 Overridden from MovableObject. More...
 
bool getNeedsUpdate (void)
 Get status of need for update. this checks all affected zones. More...
 
void removeZoneFromAffectedZonesList (PCZone *zone)
 Manually remove a zone from the affected list. More...
 
void setAffectsVisibleZone (bool affects)
 Marks a light as affecting a visible zone. More...
 
void updateZones (PCZone *defaultZone, unsigned long frameCount)
 Update the list of zones the light affects. More...
 
- Public Member Functions inherited from Ogre::Light
 Light ()
 Default constructor (for Python mainly). More...
 
 Light (const String &name)
 Normal constructor. More...
 
 ~Light ()
 Standard destructor. More...
 
void _calcTempSquareDist (const Vector3 &worldPos)
 internal method for calculating current squared distance from some world position More...
 
Real _deriveShadowFarClipDistance () const
 Derive a shadow camera far distance. More...
 
Real _deriveShadowFarClipDistance (const Camera *) const
 
Real _deriveShadowNearClipDistance (const Camera *maincam) const
 Derive a shadow camera near distance from either the light, or from the main camera if the light doesn't have its own setting. More...
 
virtual const PlaneBoundedVolumeList_getFrustumClipVolumes (const Camera *const cam) const
 Internal method for calculating the clip volumes outside of the frustum which can be used to determine which objects are casting shadow on the frustum as a whole. More...
 
size_t _getIndexInFrame () const
 Gets the index at which this light is in the current render. More...
 
virtual const PlaneBoundedVolume_getNearClipVolume (const Camera *const cam) const
 Internal method for calculating the 'near clip volume', which is the volume formed between the near clip rectangle of the camera and the light. More...
 
void _notifyAttached (Node *parent, bool isTagPoint=false)
 Internal method called to notify the object that it has been attached to a node. More...
 
void _notifyIndexInFrame (size_t i)
 
void _setCameraRelative (Camera *cam)
 Set the camera which this light should be relative to, for camera-relative rendering. More...
 
virtual void _updateCustomGpuParameter (uint16 paramIndex, const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
 Update a custom GpuProgramParameters constant which is derived from information only this Light knows. More...
 
void _updateRenderQueue (RenderQueue *queue)
 Internal method by which the movable object must add Renderable subclass instances to the rendering queue. More...
 
AnimableValuePtr createAnimableValue (const String &valueName)
 Create a reference-counted AnimableValuePtr for the named value. More...
 
Vector4 getAs4DVector (bool cameraRelativeIfSet=false) const
 Gets the details of this light as a 4D vector. More...
 
const Vector4fgetAttenuation () const
 get all attenuation params as (range, constant, linear, quadratic) More...
 
float getAttenuationConstant (void) const
 Returns the constant factor in the attenuation formula. More...
 
float getAttenuationLinear (void) const
 Returns the linear factor in the attenuation formula. More...
 
float getAttenuationQuadric (void) const
 Returns the quadric factor in the attenuation formula. More...
 
float getAttenuationRange (void) const
 Returns the absolute upper range of the light. More...
 
const AxisAlignedBoxgetBoundingBox (void) const
 Retrieves the local axis-aligned bounding box for this object. More...
 
Real getBoundingRadius (void) const
 Retrieves the radius of the origin-centered bounding sphere for this object. More...
 
const Vector4getCustomParameter (uint16 index) const
 Gets the custom value associated with this Light at the given index. More...
 
const ShadowCameraSetupPtrgetCustomShadowCameraSetup (void) const
 Return a pointer to the custom shadow camera setup (null means use SceneManager global version). More...
 
const Vector3getDerivedDirection (void) const
 Retrieves the direction of the light including any transform from nodes it is attached to. More...
 
const Vector3getDerivedPosition (bool cameraRelativeIfSet=false) const
 Retrieves the position of the light including any transform from nodes it is attached to. More...
 
const ColourValuegetDiffuseColour (void) const
 Returns the colour of the diffuse light given off by this light source (see setDiffuseColour for more info). More...
 
const Vector3getDirection (void) const
 
const Vector3getPosition (void) const
 Returns the position of the light. More...
 
Real getPowerScale (void) const
 Set the scaling factor which indicates the relative power of a light. More...
 
Real getShadowFarClipDistance () const
 Get the far clip plane distance to be used by the shadow camera, if this light casts texture shadows. More...
 
Real getShadowFarDistance (void) const
 Gets the maximum distance away from the camera that shadows by this light will be visible. More...
 
Real getShadowFarDistanceSquared (void) const
 
Real getShadowNearClipDistance () const
 Get the near clip plane distance to be used by the shadow camera, if this light casts texture shadows. More...
 
const ColourValuegetSpecularColour (void) const
 Returns the colour of specular light given off by this light source. More...
 
Real getSpotlightFalloff (void) const
 Returns the falloff between the inner and outer cones of the spotlight. More...
 
const RadiangetSpotlightInnerAngle (void) const
 Returns the angle covered by the spotlights inner cone. More...
 
Real getSpotlightNearClipDistance () const
 Get the near clip plane distance to be used by spotlights that use light clipping. More...
 
const RadiangetSpotlightOuterAngle (void) const
 Returns the angle covered by the spotlights outer cone. More...
 
LightTypes getType (void) const
 Returns the light type. More...
 
uint32 getTypeFlags (void) const
 Override to return specific type flag. More...
 
bool isInLightRange (const Ogre::AxisAlignedBox &container) const
 Check whether a bounding box is included in the lighted area of the light. More...
 
bool isInLightRange (const Ogre::Sphere &sphere) const
 Check whether a sphere is included in the lighted area of the light. More...
 
void resetCustomShadowCameraSetup (void)
 Reset the shadow camera setup to the default. More...
 
void resetShadowFarDistance (void)
 Tells the light to use the shadow far distance of the SceneManager. More...
 
void setAttenuation (float range, float constant, float linear, float quadratic)
 Sets the attenuation parameters of the light source i.e. More...
 
void setCustomParameter (uint16 index, const Vector4 &value)
 Sets a custom parameter for this Light, which may be used to drive calculations for this specific Renderable, like GPU program parameters. More...
 
void setCustomShadowCameraSetup (const ShadowCameraSetupPtr &customShadowSetup)
 Set this light to use a custom shadow camera when rendering texture shadows. More...
 
void setDiffuseColour (const ColourValue &colour)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
void setDiffuseColour (float red, float green, float blue)
 Sets the colour of the diffuse light given off by this source. More...
 
void setDirection (const Vector3 &vec)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
void setDirection (Real x, Real y, Real z)
 
void setPosition (const Vector3 &vec)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
void setPosition (Real x, Real y, Real z)
 Sets the position of the light. More...
 
void setPowerScale (Real power)
 Set a scaling factor to indicate the relative power of a light. More...
 
void setShadowFarClipDistance (Real farClip)
 Set the far clip plane distance to be used by the shadow camera, if this light casts texture shadows. More...
 
void setShadowFarDistance (Real distance)
 Sets the maximum distance away from the camera that shadows by this light will be visible. More...
 
void setShadowNearClipDistance (Real nearClip)
 Set the near clip plane distance to be used by the shadow camera, if this light casts texture shadows. More...
 
void setSpecularColour (const ColourValue &colour)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
void setSpecularColour (float red, float green, float blue)
 Sets the colour of the specular light given off by this source. More...
 
void setSpotlightFalloff (Real val)
 Sets the falloff between the inner and outer cones of the spotlight. More...
 
void setSpotlightInnerAngle (const Radian &val)
 Sets the angle covered by the spotlights inner cone. More...
 
void setSpotlightNearClipDistance (Real nearClip)
 Set the near clip plane distance to be used by spotlights that use light clipping, allowing you to render spots as if they start from further down their frustum. More...
 
void setSpotlightOuterAngle (const Radian &val)
 Sets the angle covered by the spotlights outer cone. More...
 
void setSpotlightRange (const Radian &innerAngle, const Radian &outerAngle, Real falloff=1.0)
 Sets the range of a spotlight, i.e. More...
 
void setType (LightTypes type)
 Sets the type of light - see LightTypes for more info. More...
 
void setVisible (bool visible)
 Tells this object whether to be visible or not, if it has a renderable component. More...
 
void visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)
 Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any. More...
 
- Public Member Functions inherited from Ogre::MovableObject
 MovableObject ()
 Constructor. More...
 
 MovableObject (const String &name)
 Named constructor. More...
 
virtual ~MovableObject ()
 Virtual destructor - read Scott Meyers if you don't know why this is needed. More...
 
MovableObjectFactory_getCreator (void) const
 Get the creator of this object, if any (internal use only) More...
 
LightList_getLightList ()
 Returns a pointer to the current list of lights for this object. More...
 
SceneManager_getManager (void) const
 Get the manager of this object, if any (internal use only) More...
 
virtual const Affine3_getParentNodeFullTransform (void) const
 Return the full transformation of the parent sceneNode or the attachingPoint node. More...
 
virtual void _notifyCreator (MovableObjectFactory *fact)
 Notify the object of it's creator (internal use only) More...
 
virtual void _notifyCurrentCamera (Camera *cam)
 Internal method to notify the object of the camera to be used for the next rendering operation. More...
 
virtual void _notifyManager (SceneManager *man)
 Notify the object of it's manager (internal use only) More...
 
virtual void _releaseManualHardwareResources ()
 Notifies the movable object that hardware resources were lost. More...
 
virtual void _restoreManualHardwareResources ()
 Notifies the movable object that hardware resources should be restored. More...
 
void addQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
void addVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
void detachFromParent (void)
 Detaches an object from a parent SceneNode or TagPoint, if attached. More...
 
bool getCastShadows (void) const
 Returns whether shadow casting is enabled for this object. More...
 
const AxisAlignedBoxgetDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const override
 Gets the world space bounding box of the dark cap, as extruded using the light provided. More...
 
EdgeDatagetEdgeList (void)
 Returns details of the edges which might be used to determine a silhouette. More...
 
const AxisAlignedBoxgetLightCapBounds (void) const override
 Gets the world space bounding box of the light cap. More...
 
uint32 getLightMask () const
 Get a bitwise mask which will filter the lights affecting this object. More...
 
ListenergetListener (void) const
 Gets the current listener for this object. More...
 
const StringgetName (void) const
 Returns the name of this object. More...
 
NodegetParentNode (void) const
 Returns the node to which this object is attached. More...
 
SceneNodegetParentSceneNode (void) const
 Returns the scene node to which this object is attached. More...
 
Real getPointExtrusionDistance (const Light *l) const
 Get the distance to extrude for a point/spot light. More...
 
uint32 getQueryFlags (void) const
 Returns the query flags relevant for this object. More...
 
bool getReceivesShadows ()
 Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More...
 
Real getRenderingDistance (void) const
 Gets the distance at which batches are no longer rendered. More...
 
Real getRenderingMinPixelSize () const
 Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
uint8 getRenderQueueGroup (void) const
 Gets the queue group for this entity. More...
 
const ShadowRenderableListgetShadowVolumeRenderableList (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDist, unsigned long flags=0)
 Define a default implementation of method from ShadowCaster which implements no shadows. More...
 
const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
uint32 getVisibilityFlags (void) const
 Returns the visibility flags relevant for this object. More...
 
bool getVisible (void) const
 Gets this object whether to be visible or not, if it has a renderable component. More...
 
virtual const AxisAlignedBoxgetWorldBoundingBox (bool derive=false) const
 Retrieves the axis-aligned bounding box for this object in world coordinates. More...
 
virtual const SpheregetWorldBoundingSphere (bool derive=false) const
 Retrieves the worldspace bounding sphere for this object. More...
 
bool isAttached (void) const
 Returns true if this object is attached to a SceneNode or TagPoint. More...
 
bool isDebugDisplayEnabled (void) const
 Gets whether debug display of this object is enabled. More...
 
virtual bool isInScene (void) const
 Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph. More...
 
bool isParentTagPoint () const
 Gets whether the parent node is a TagPoint (or a SceneNode) More...
 
virtual bool isVisible (void) const
 Returns whether or not this object is supposed to be visible or not. More...
 
const LightListqueryLights (void) const
 Gets a list of lights, ordered relative to how close they are to this movable object. More...
 
void removeQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void removeVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void setCastShadows (bool enabled)
 Sets whether or not this object will cast shadows. More...
 
void setDebugDisplayEnabled (bool enabled)
 Sets whether or not the debug display of this object is enabled. More...
 
void setLightMask (uint32 lightMask)
 Set a bitwise mask which will filter the lights affecting this object. More...
 
void setListener (Listener *listener)
 Sets a listener for this object. More...
 
void setQueryFlags (uint32 flags)
 Sets the query flags for this object. More...
 
void setRenderingDistance (Real dist)
 Sets the distance at which the object is no longer rendered. More...
 
void setRenderingMinPixelSize (Real pixelSize)
 Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
virtual void setRenderQueueGroup (uint8 queueID)
 Sets the render queue group this entity will be rendered through. More...
 
virtual void setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
 Sets the render queue group and group priority this entity will be rendered through. More...
 
void setUserAny (const Any &anything)
 
void setVisibilityFlags (uint32 flags)
 Sets the visibility flags for this object. More...
 
void setVisible (bool visible)
 Tells this object whether to be visible or not, if it has a renderable component. More...
 
- Public Member Functions inherited from Ogre::ShadowCaster
virtual ~ShadowCaster ()
 
virtual ShadowRenderableListIterator getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDistance, unsigned long flags=0)
 
bool hasEdgeList ()
 Returns whether the object has a valid edge list. More...
 
- Public Member Functions inherited from Ogre::AnimableObject
 AnimableObject ()
 
virtual ~AnimableObject ()
 
const StringVectorgetAnimableValueNames (void) const
 Gets a list of animable value names for this object. More...
 

Additional Inherited Members

- Public Types inherited from Ogre::Light
enum  LightTypes { LT_POINT = 0, LT_DIRECTIONAL = 1, LT_SPOTLIGHT = 2 }
 Defines the type of light. More...
 
- Public Types inherited from Ogre::ShadowCaster
typedef std::vector< ShadowRenderable * > ShadowRenderableList
 
typedef VectorIterator< ShadowRenderableListShadowRenderableListIterator
 
- Static Public Member Functions inherited from Ogre::MovableObject
static uint32 getDefaultQueryFlags ()
 Get the default query flags for all future MovableObject instances. More...
 
static uint32 getDefaultVisibilityFlags ()
 Get the default visibility flags for all future MovableObject instances. More...
 
static void setDefaultQueryFlags (uint32 flags)
 Set the default query flags for all future MovableObject instances. More...
 
static void setDefaultVisibilityFlags (uint32 flags)
 Set the default visibility flags for all future MovableObject instances. More...
 
- Static Public Member Functions inherited from Ogre::ShadowCaster
static void clearShadowRenderableList (ShadowRenderableList &shadowRenderables)
 Common implementation of releasing shadow renderables. More...
 
static void extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
 Utility method for extruding vertices based on a light. More...
 
- Public Attributes inherited from Ogre::Light
Real tempSquareDist
 Temp tag used for sorting. More...
 

Detailed Description

Specialized version of Ogre::Light which caches which zones the light affects.

Constructor & Destructor Documentation

◆ PCZLight() [1/2]

Ogre::PCZLight::PCZLight ( )

Default constructor (for Python mainly).

◆ PCZLight() [2/2]

Ogre::PCZLight::PCZLight ( const String name)

Normal constructor.

Should not be called directly, but rather the SceneManager::createLight method should be used.

◆ ~PCZLight()

Ogre::PCZLight::~PCZLight ( )

Standard destructor.

Member Function Documentation

◆ getMovableType()

const String& Ogre::PCZLight::getMovableType ( void  ) const
virtual

Overridden from MovableObject.

Reimplemented from Ogre::Light.

◆ clearAffectedZones()

void Ogre::PCZLight::clearAffectedZones ( void  )

Clear the affectedZonesList.

◆ addZoneToAffectedZonesList()

void Ogre::PCZLight::addZoneToAffectedZonesList ( PCZone zone)

Manually add a zone to the zones affected list.

◆ affectsZone()

bool Ogre::PCZLight::affectsZone ( PCZone zone)

Check if a zone is in the list of zones affected by the light.

◆ affectsVisibleZone()

bool Ogre::PCZLight::affectsVisibleZone ( void  )
inline
Returns
Flag indicating if the light affects a zone which is visible in the current frame

◆ setAffectsVisibleZone()

void Ogre::PCZLight::setAffectsVisibleZone ( bool  affects)
inline

Marks a light as affecting a visible zone.

◆ updateZones()

void Ogre::PCZLight::updateZones ( PCZone defaultZone,
unsigned long  frameCount 
)

Update the list of zones the light affects.

◆ removeZoneFromAffectedZonesList()

void Ogre::PCZLight::removeZoneFromAffectedZonesList ( PCZone zone)

Manually remove a zone from the affected list.

◆ _notifyMoved()

virtual void Ogre::PCZLight::_notifyMoved ( void  )
virtual

MovableObject notified when SceneNode changes.

Reimplemented from Ogre::Light.

◆ clearNeedsUpdate()

void Ogre::PCZLight::clearNeedsUpdate ( void  )
inline

Clear update flag.

◆ getNeedsUpdate()

bool Ogre::PCZLight::getNeedsUpdate ( void  )

Get status of need for update. this checks all affected zones.


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