Specialized version of Ogre::Light which caches which zones the light affects. More...
#include <OgrePCZLight.h>
Public Types | |
enum | LightTypes { LT_POINT = 0, LT_DIRECTIONAL = 1, LT_SPOTLIGHT = 2 } |
Defines the type of light. More... | |
typedef vector < ShadowRenderable * >::type | ShadowRenderableList |
typedef VectorIterator < ShadowRenderableList > | ShadowRenderableListIterator |
Public Member Functions | |
PCZLight () | |
Default constructor (for Python mainly). More... | |
PCZLight (const String &name) | |
Normal constructor. More... | |
~PCZLight () | |
Standard destructor. More... | |
void | _calcTempSquareDist (const Vector3 &worldPos) |
internal method for calculating current squared distance from some world position More... | |
Real | _deriveShadowFarClipDistance (const Camera *maincam) const |
Derive a shadow camera far distance from either the light, or from the main camera if the light doesn't have its own setting. More... | |
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 MovableObjectFactory * | _getCreator (void) const |
Get the creator of this object, if any (internal use only) 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 LightList * | _getLightList () |
Returns a pointer to the current list of lights for this object. More... | |
virtual SceneManager * | _getManager (void) const |
Get the manager of this object, if any (internal use only) 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... | |
virtual const Matrix4 & | _getParentNodeFullTransform (void) const |
return the full transformation of the parent sceneNode or the attachingPoint node More... | |
void | _notifyAttached (Node *parent, bool isTagPoint=false) |
Overridden from MovableObject. 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... | |
void | _notifyIndexInFrame (size_t i) |
virtual void | _notifyManager (SceneManager *man) |
Notify the object of it's manager (internal use only) More... | |
virtual void | _notifyMoved (void) |
Overridden from MovableObject. More... | |
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) |
Overridden from MovableObject. More... | |
virtual void | addQueryFlags (uint32 flags) |
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More... | |
virtual void | addVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More... | |
void | addZoneToAffectedZonesList (PCZone *zone) |
Manually add a zone to the zones affected list. More... | |
bool | affectsVisibleZone (void) |
returns flag indicating if the light affects a zone which is visible in the current frame More... | |
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) |
AnimableValuePtr | createAnimableValue (const String &valueName) |
Create a reference-counted AnimableValuePtr for the named value. More... | |
virtual void | detachFromParent (void) |
Detaches an object from a parent SceneNode or TagPoint, if attached. More... | |
const StringVector & | getAnimableValueNames (void) const |
Gets a list of animable value names for this object. More... | |
Vector4 | getAs4DVector (bool cameraRelativeIfSet=false) const |
Gets the details of this light as a 4D vector. More... | |
Real | getAttenuationConstant (void) const |
Returns the constant factor in the attenuation formula. More... | |
Real | getAttenuationLinear (void) const |
Returns the linear factor in the attenuation formula. More... | |
Real | getAttenuationQuadric (void) const |
Returns the quadric factor in the attenuation formula. More... | |
Real | getAttenuationRange (void) const |
Returns the absolute upper range of the light. More... | |
const AxisAlignedBox & | getBoundingBox (void) const |
Overridden from MovableObject. More... | |
Real | getBoundingRadius (void) const |
Overridden from MovableObject. More... | |
bool | getCastShadows (void) const |
Returns whether shadow casting is enabled for this object. More... | |
const Vector4 & | getCustomParameter (uint16 index) const |
Gets the custom value associated with this Light at the given index. More... | |
const ShadowCameraSetupPtr & | getCustomShadowCameraSetup (void) const |
return a pointer to the custom shadow camera setup (null means use SceneManager global version). More... | |
const AxisAlignedBox & | getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const |
Overridden member from ShadowCaster. More... | |
const Vector3 & | getDerivedDirection (void) const |
Retrieves the direction of the light including any transform from nodes it is attached to. More... | |
const Vector3 & | getDerivedPosition (bool cameraRelativeIfSet=false) const |
Retrieves the position of the light including any transform from nodes it is attached to. More... | |
const ColourValue & | getDiffuseColour (void) const |
Returns the colour of the diffuse light given off by this light source (see setDiffuseColour for more info). More... | |
const Vector3 & | getDirection (void) const |
Returns the light's direction. More... | |
EdgeData * | getEdgeList (void) |
Define a default implementation of method from ShadowCaster which implements no shadows. More... | |
const AxisAlignedBox & | getLightCapBounds (void) const |
Overridden member from ShadowCaster. More... | |
virtual uint32 | getLightMask () const |
Get a bitwise mask which will filter the lights affecting this object. More... | |
virtual Listener * | getListener (void) const |
Gets the current listener for this object. More... | |
const String & | getMovableType (void) const |
Overridden from MovableObject. More... | |
virtual const String & | getName (void) const |
Returns the name of this object. More... | |
bool | getNeedsUpdate (void) |
virtual Node * | getParentNode (void) const |
Returns the node to which this object is attached. More... | |
virtual SceneNode * | getParentSceneNode (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... | |
const Vector3 & | getPosition (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... | |
virtual 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... | |
virtual Real | getRenderingDistance (void) const |
Gets the distance at which batches are no longer rendered. More... | |
virtual Real | getRenderingMinPixelSize () const |
Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More... | |
virtual uint8 | getRenderQueueGroup (void) const |
Gets the queue group for this entity, see setRenderQueueGroup for full details. 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... | |
ShadowRenderableListIterator | getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, bool extrudeVertices, Real extrusionDist, unsigned long flags=0) |
Define a default implementation of method from ShadowCaster which implements no shadows. More... | |
const ColourValue & | getSpecularColour (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 Radian & | getSpotlightInnerAngle (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 Radian & | getSpotlightOuterAngle (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... | |
virtual const Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. More... | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. More... | |
virtual uint32 | getVisibilityFlags (void) const |
Returns the visibility flags relevant for this object. More... | |
virtual bool | getVisible (void) const |
Gets this object whether to be visible or not, if it has a renderable component. More... | |
virtual const AxisAlignedBox & | getWorldBoundingBox (bool derive=false) const |
Retrieves the axis-aligned bounding box for this object in world coordinates. More... | |
virtual const Sphere & | getWorldBoundingSphere (bool derive=false) const |
Retrieves the worldspace bounding sphere for this object. More... | |
bool | hasEdgeList (void) |
Define a default implementation of method from ShadowCaster which implements no shadows. More... | |
virtual bool | isAttached (void) const |
Returns true if this object is attached to a SceneNode or TagPoint. More... | |
virtual 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... | |
virtual 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... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
virtual const LightList & | queryLights (void) const |
Gets a list of lights, ordered relative to how close they are to this movable object. More... | |
virtual void | removeQueryFlags (uint32 flags) |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More... | |
virtual void | removeVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More... | |
void | removeZoneFromAffectedZonesList (PCZone *zone) |
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 | setAffectsVisibleZone (bool affects) |
Marks a light as affecting a visible zone. More... | |
void | setAttenuation (Real range, Real constant, Real linear, Real quadratic) |
Sets the attenuation parameters of the light source i.e. More... | |
void | setCastShadows (bool enabled) |
Sets whether or not this object will cast shadows. 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... | |
virtual void | setDebugDisplayEnabled (bool enabled) |
Sets whether or not the debug display of this object is enabled. More... | |
void | setDiffuseColour (Real red, Real green, Real blue) |
Sets the colour of the diffuse light given off by this source. More... | |
void | setDiffuseColour (const ColourValue &colour) |
Sets the colour of the diffuse light given off by this source. More... | |
void | setDirection (Real x, Real y, Real z) |
Sets the direction in which a light points. More... | |
void | setDirection (const Vector3 &vec) |
Sets the direction in which a light points. More... | |
virtual void | setLightMask (uint32 lightMask) |
Set a bitwise mask which will filter the lights affecting this object. More... | |
virtual void | setListener (Listener *listener) |
Sets a listener for this object. More... | |
void | setPosition (Real x, Real y, Real z) |
Sets the position of the light. More... | |
void | setPosition (const Vector3 &vec) |
Sets the position of the light. More... | |
void | setPowerScale (Real power) |
Set a scaling factor to indicate the relative power of a light. More... | |
virtual void | setQueryFlags (uint32 flags) |
Sets the query flags for this object. More... | |
virtual void | setRenderingDistance (Real dist) |
Sets the distance at which the object is no longer rendered. More... | |
virtual 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 | 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 (Real red, Real green, Real blue) |
Sets the colour of the specular light given off by this source. More... | |
void | setSpecularColour (const ColourValue &colour) |
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... | |
virtual void | setUserAny (const Any &anything) |
virtual void | setVisibilityFlags (uint32 flags) |
Sets the visiblity flags for this object. More... | |
void | setVisible (bool visible) |
Overridden from MovableObject. More... | |
void | updateZones (PCZone *defaultZone, unsigned long frameCount) |
Update the list of zones the light affects. 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... | |
Static Public Member Functions | |
static void | extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist) |
Utility method for extruding vertices based on a light. More... | |
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... | |
Public Attributes | |
Real | tempSquareDist |
Temp tag used for sorting. More... | |
Protected Types | |
typedef map< String, StringVector >::type | AnimableDictionaryMap |
typedef map< uint16, Vector4 > ::type | CustomParameterMap |
Protected Member Functions | |
StringVector & | _getAnimableValueNames (void) |
Get an updateable reference to animable value list. More... | |
void | createAnimableDictionary (void) const |
Internal method for creating a dictionary of animable value names for the class, if it does not already exist. More... | |
virtual void | extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const |
Utility method for extruding a bounding box. More... | |
virtual void | generateShadowVolume (EdgeData *edgeData, const HardwareIndexBufferSharedPtr &indexBuffer, const Light *light, ShadowRenderableList &shadowRenderables, unsigned long flags) |
Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it. More... | |
const String & | getAnimableDictionaryName (void) const |
Get the name of the animable dictionary for this class. More... | |
Real | getExtrusionDistance (const Vector3 &objectPos, const Light *light) const |
Helper method for calculating extrusion distance. More... | |
void | initialiseAnimableDictionary (StringVector &vec) const |
Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. More... | |
virtual void | update (void) const |
internal method for synchronising with parent node (if any) More... | |
virtual void | updateEdgeListLightFacing (EdgeData *edgeData, const Vector4 &lightPos) |
Tells the caster to perform the tasks necessary to update the edge data's light listing. More... | |
Protected Attributes | |
ZoneList | affectedZonesList |
List of PCZones which are affected by the light. More... | |
bool | mAffectsVisibleZone |
flag indicating if any of the zones in the affectedZonesList is visible in the current frame More... | |
Real | mAttenuationConst |
Real | mAttenuationLinear |
Real | mAttenuationQuad |
bool | mBeyondFarDistance |
Hidden because of distance? More... | |
Camera * | mCameraToBeRelativeTo |
bool | mCastShadows |
Does this object cast shadows? More... | |
MovableObjectFactory * | mCreator |
Creator of this object (if created by a factory) More... | |
CustomParameterMap | mCustomParameters |
Stores the custom parameters for the light. More... | |
ShadowCameraSetupPtr | mCustomShadowCameraSetup |
Pointer to a custom shadow camera setup. More... | |
bool | mDebugDisplay |
Is debug display enabled? More... | |
bool | mDerivedCamRelativeDirty |
Vector3 | mDerivedCamRelativePosition |
Vector3 | mDerivedDirection |
Vector3 | mDerivedPosition |
bool | mDerivedTransformDirty |
Is the derived transform dirty? More... | |
ColourValue | mDiffuse |
Vector3 | mDirection |
PlaneBoundedVolumeList | mFrustumClipVolumes |
size_t | mIndexInFrame |
LightList | mLightList |
List of lights for this object. More... | |
ulong | mLightListUpdated |
The last frame that this light list was updated in. More... | |
uint32 | mLightMask |
the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable More... | |
LightTypes | mLightType |
Listener * | mListener |
MovableObject listener - only one allowed (no list) for size & performance reasons. */. More... | |
SceneManager * | mManager |
SceneManager holding this object (if applicable) More... | |
Real | mMinPixelSize |
String | mName |
Name of this object. More... | |
PlaneBoundedVolume | mNearClipVolume |
bool | mNeedsUpdate |
bool | mOwnShadowFarDist |
bool | mParentIsTagPoint |
Node * | mParentNode |
node to which this object is attached More... | |
Vector3 | mPosition |
Real | mPowerScale |
uint32 | mQueryFlags |
Flags determining whether this object is included / excluded from scene queries. More... | |
Real | mRange |
bool | mRenderingDisabled |
Does rendering this object disabled by listener? More... | |
uint8 | mRenderQueueID |
The render queue to use when rendering this object. More... | |
bool | mRenderQueueIDSet |
Flags whether the RenderQueue's default should be used. More... | |
ushort | mRenderQueuePriority |
The render queue group to use when rendering this object. More... | |
bool | mRenderQueuePrioritySet |
Flags whether the RenderQueue's default should be used. More... | |
Real | mShadowFarClipDist |
Real | mShadowFarDist |
Real | mShadowFarDistSquared |
Real | mShadowNearClipDist |
ColourValue | mSpecular |
Real | mSpotFalloff |
Radian | mSpotInner |
Real | mSpotNearClip |
Radian | mSpotOuter |
Real | mSquaredUpperDistance |
Real | mUpperDistance |
Upper distance to still render. More... | |
UserObjectBindings | mUserObjectBindings |
User objects binding. More... | |
uint32 | mVisibilityFlags |
Flags determining whether this object is visible (compared to SceneManager mask) More... | |
bool | mVisible |
Is this object visible? More... | |
AxisAlignedBox | mWorldAABB |
Cached world AABB of this object. More... | |
Sphere | mWorldBoundingSphere |
AxisAlignedBox | mWorldDarkCapBounds |
World space AABB of this object's dark cap. More... | |
Static Protected Attributes | |
static AnimableDictionaryMap | msAnimableDictionary |
Static map of class name to list of animable value names. More... | |
static uint32 | msDefaultQueryFlags |
Default query flags. More... | |
static uint32 | msDefaultVisibilityFlags |
Default visibility flags. More... | |
static String | msMovableType |
Shared class-level name for Movable type. More... | |
Specialized version of Ogre::Light which caches which zones the light affects.
Definition at line 52 of file OgrePCZLight.h.
|
protectedinherited |
Definition at line 241 of file OgreAnimable.h.
|
protectedinherited |
Definition at line 574 of file OgreLight.h.
|
inherited |
Definition at line 136 of file OgreShadowCaster.h.
|
inherited |
Definition at line 137 of file OgreShadowCaster.h.
|
inherited |
Defines the type of light.
Definition at line 82 of file OgreLight.h.
Ogre::PCZLight::PCZLight | ( | ) |
Default constructor (for Python mainly).
Ogre::PCZLight::PCZLight | ( | const String & | name | ) |
Normal constructor.
Should not be called directly, but rather the SceneManager::createLight method should be used.
Ogre::PCZLight::~PCZLight | ( | ) |
Standard destructor.
|
inherited |
internal method for calculating current squared distance from some world position
Derive a shadow camera far distance from either the light, or from the main camera if the light doesn't have its own setting.
Derive a shadow camera near distance from either the light, or from the main camera if the light doesn't have its own setting.
|
inlineprotectedinherited |
Get an updateable reference to animable value list.
Definition at line 267 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
inlinevirtualinherited |
Get the creator of this object, if any (internal use only)
Definition at line 186 of file OgreMovableObject.h.
|
virtualinherited |
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.
|
inlineinherited |
Gets the index at which this light is in the current render.
Definition at line 404 of file OgreLight.h.
|
inlinevirtualinherited |
Returns a pointer to the current list of lights for this object.
Definition at line 491 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Get the manager of this object, if any (internal use only)
Definition at line 190 of file OgreMovableObject.h.
|
virtualinherited |
Internal method for calculating the 'near clip volume', which is the volume formed between the near clip rectangle of the camera and the light.
|
virtualinherited |
return the full transformation of the parent sceneNode or the attachingPoint node
Reimplemented in Ogre::InstancedEntity.
|
virtualinherited |
Overridden from MovableObject.
Reimplemented from Ogre::MovableObject.
|
inlinevirtualinherited |
Notify the object of it's creator (internal use only)
Definition at line 184 of file OgreMovableObject.h.
|
virtualinherited |
Internal method to notify the object of the camera to be used for the next rendering operation.
Reimplemented in Ogre::BillboardSet, Ogre::InstancedGeometry::BatchInstance, Ogre::Frustum, Ogre::StaticGeometry::Region, Ogre::Entity, Ogre::ParticleSystem, Ogre::InstanceBatch, Ogre::SimpleRenderable, and Ogre::MovablePlane.
|
inlineinherited |
Definition at line 405 of file OgreLight.h.
|
inlinevirtualinherited |
Notify the object of it's manager (internal use only)
Definition at line 188 of file OgreMovableObject.h.
|
virtual |
Overridden from MovableObject.
Reimplemented from Ogre::Light.
|
inherited |
Set the camera which this light should be relative to, for camera-relative rendering.
|
virtualinherited |
Update a custom GpuProgramParameters constant which is derived from information only this Light knows.
paramIndex | The index of the constant being updated |
constantEntry | The auto constant entry from the program parameters |
params | The parameters object which this method should call to set the updated parameters. |
|
virtualinherited |
Overridden from MovableObject.
Implements Ogre::MovableObject.
|
inlinevirtualinherited |
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
Definition at line 396 of file OgreMovableObject.h.
|
inlinevirtualinherited |
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.
Definition at line 424 of file OgreMovableObject.h.
void Ogre::PCZLight::addZoneToAffectedZonesList | ( | PCZone * | zone | ) |
Manually add a zone to the zones affected list.
|
inline |
returns flag indicating if the light affects a zone which is visible in the current frame
Definition at line 85 of file OgrePCZLight.h.
bool Ogre::PCZLight::affectsZone | ( | PCZone * | zone | ) |
check if a zone is in the list of zones affected by the light
void Ogre::PCZLight::clearAffectedZones | ( | void | ) |
Clear the affectedZonesList.
|
inline |
Definition at line 100 of file OgrePCZLight.h.
|
inlineprotectedinherited |
Internal method for creating a dictionary of animable value names for the class, if it does not already exist.
Definition at line 254 of file OgreAnimable.h.
|
virtualinherited |
Create a reference-counted AnimableValuePtr for the named value.
Reimplemented from Ogre::AnimableObject.
|
virtualinherited |
|
protectedvirtualinherited |
Utility method for extruding a bounding box.
box | Original bounding box, will be updated in-place |
lightPos | 4D light position in object space, when w=0.0f this represents a directional light |
extrudeDist | The distance to extrude |
|
staticinherited |
Utility method for extruding vertices based on a light.
vertexBuffer | The vertex buffer containing ONLY xyz position values, which must be originalVertexCount * 2 * 3 floats long. |
originalVertexCount | The count of the original number of vertices, i.e. the number in the mesh, not counting the doubling which has already been done (by VertexData::prepareForShadowVolume) to provide the extruded area of the buffer. |
lightPos | 4D light position in object space, when w=0.0f this represents a directional light |
extrudeDist | The distance to extrude |
|
protectedvirtualinherited |
Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it.
edgeData | The edge information to use |
indexBuffer | The buffer into which to write data into; current contents are assumed to be discardable. |
light | The light, mainly for type info as silhouette calculations should already have been done in updateEdgeListLightFacing |
shadowRenderables | A list of shadow renderables which has already been constructed but will need populating with details of the index ranges to be used. |
flags | Additional controller flags, see ShadowRenderableFlags |
|
protectedvirtualinherited |
Get the name of the animable dictionary for this class.
Reimplemented from Ogre::AnimableObject.
|
inlineinherited |
Gets a list of animable value names for this object.
Definition at line 295 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
inherited |
Gets the details of this light as a 4D vector.
cameraRelativeIfSet | If set to true, returns data in camera-relative units if that's been set up (render use) |
|
inherited |
Returns the constant factor in the attenuation formula.
|
inherited |
Returns the linear factor in the attenuation formula.
|
inherited |
Returns the quadric factor in the attenuation formula.
|
inherited |
Returns the absolute upper range of the light.
|
virtualinherited |
Overridden from MovableObject.
Implements Ogre::MovableObject.
|
inlinevirtualinherited |
Overridden from MovableObject.
Implements Ogre::MovableObject.
Definition at line 338 of file OgreLight.h.
|
inlinevirtualinherited |
Returns whether shadow casting is enabled for this object.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 521 of file OgreMovableObject.h.
Gets the custom value associated with this Light at the given index.
see setCustomParameter for full details. |
|
inherited |
return a pointer to the custom shadow camera setup (null means use SceneManager global version).
|
virtualinherited |
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster.
|
inlinestaticinherited |
Get the default query flags for all future MovableObject instances.
Definition at line 411 of file OgreMovableObject.h.
|
inlinestaticinherited |
Get the default visibility flags for all future MovableObject instances.
Definition at line 439 of file OgreMovableObject.h.
|
inherited |
Retrieves the direction of the light including any transform from nodes it is attached to.
|
inherited |
Retrieves the position of the light including any transform from nodes it is attached to.
cameraRelativeIfSet | If set to true, returns data in camera-relative units if that's been set up (render use) |
|
inherited |
Returns the colour of the diffuse light given off by this light source (see setDiffuseColour for more info).
|
inherited |
Returns the light's direction.
|
inlinevirtualinherited |
Define a default implementation of method from ShadowCaster which implements no shadows.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::StaticGeometry::Region.
Definition at line 494 of file OgreMovableObject.h.
|
protectedinherited |
Helper method for calculating extrusion distance.
|
virtualinherited |
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster.
|
inlinevirtualinherited |
Get a bitwise mask which will filter the lights affecting this object.
Definition at line 476 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Gets the current listener for this object.
Definition at line 450 of file OgreMovableObject.h.
|
virtual |
Overridden from MovableObject.
Reimplemented from Ogre::Light.
|
inlinevirtualinherited |
Returns the name of this object.
Definition at line 193 of file OgreMovableObject.h.
bool Ogre::PCZLight::getNeedsUpdate | ( | void | ) |
|
virtualinherited |
Returns the node to which this object is attached.
|
virtualinherited |
Returns the scene node to which this object is attached.
Get the distance to extrude for a point/spot light.
Implements Ogre::ShadowCaster.
|
inherited |
Returns the position of the light.
|
inherited |
Set the scaling factor which indicates the relative power of a light.
|
inlinevirtualinherited |
Returns the query flags relevant for this object.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 403 of file OgreMovableObject.h.
|
inherited |
Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.
|
inlinevirtualinherited |
Gets the distance at which batches are no longer rendered.
Definition at line 305 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.
Definition at line 318 of file OgreMovableObject.h.
|
virtualinherited |
Gets the queue group for this entity, see setRenderQueueGroup for full details.
|
inlineinherited |
Get the far clip plane distance to be used by the shadow camera, if this light casts texture shadows.
Definition at line 464 of file OgreLight.h.
|
inherited |
Gets the maximum distance away from the camera that shadows by this light will be visible.
|
inherited |
|
inlineinherited |
Get the near clip plane distance to be used by the shadow camera, if this light casts texture shadows.
Definition at line 443 of file OgreLight.h.
|
virtualinherited |
Define a default implementation of method from ShadowCaster which implements no shadows.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::StaticGeometry::Region.
|
inherited |
Returns the colour of specular light given off by this light source.
|
inherited |
Returns the falloff between the inner and outer cones of the spotlight.
|
inherited |
Returns the angle covered by the spotlights inner cone.
|
inlineinherited |
Get the near clip plane distance to be used by spotlights that use light clipping.
Definition at line 291 of file OgreLight.h.
|
inherited |
Returns the angle covered by the spotlights outer cone.
|
inherited |
Returns the light type.
|
virtualinherited |
Override to return specific type flag.
Reimplemented from Ogre::MovableObject.
|
inlinevirtualinherited |
Definition at line 334 of file OgreMovableObject.h.
|
inlineinherited |
Return an instance of user objects binding associated with this class.
You can use it to associate one or more custom objects with this class instance.
Definition at line 340 of file OgreMovableObject.h.
|
inlineinherited |
Return an instance of user objects binding associated with this class.
You can use it to associate one or more custom objects with this class instance.
Definition at line 346 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Returns the visibility flags relevant for this object.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 431 of file OgreMovableObject.h.
|
virtualinherited |
Gets this object whether to be visible or not, if it has a renderable component.
|
virtualinherited |
Retrieves the axis-aligned bounding box for this object in world coordinates.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::Entity, and Ogre::PortalBase.
|
virtualinherited |
Retrieves the worldspace bounding sphere for this object.
Reimplemented in Ogre::Entity, and Ogre::PortalBase.
|
inlinevirtualinherited |
Define a default implementation of method from ShadowCaster which implements no shadows.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::StaticGeometry::Region.
Definition at line 496 of file OgreMovableObject.h.
|
protectedvirtualinherited |
Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.
Reimplemented from Ogre::AnimableObject.
|
virtualinherited |
|
inlinevirtualinherited |
Gets whether debug display of this object is enabled.
Definition at line 565 of file OgreMovableObject.h.
|
virtualinherited |
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.
Reimplemented in Ogre::InstancedEntity.
|
inlinevirtualinherited |
Gets whether the parent node is a TagPoint (or a SceneNode)
Definition at line 216 of file OgreMovableObject.h.
|
virtualinherited |
Returns whether or not this object is supposed to be visible or not.
Reimplemented in Ogre::InstancedGeometry::BatchInstance, Ogre::StaticGeometry::Region, and Ogre::TerrainQuadTreeNode::Movable.
|
inlineinherited |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 67 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 85 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
|
virtualinherited |
Gets a list of lights, ordered relative to how close they are to this movable object.
|
inlinevirtualinherited |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
Definition at line 400 of file OgreMovableObject.h.
|
inlinevirtualinherited |
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.
Definition at line 428 of file OgreMovableObject.h.
void Ogre::PCZLight::removeZoneFromAffectedZonesList | ( | PCZone * | zone | ) |
|
inherited |
Reset the shadow camera setup to the default.
|
inherited |
Tells the light to use the shadow far distance of the SceneManager.
|
inline |
Marks a light as affecting a visible zone.
Definition at line 88 of file OgrePCZLight.h.
|
inherited |
Sets the attenuation parameters of the light source i.e.
how it diminishes with distance.
range | The absolute upper range of the light in world units |
constant | The constant factor in the attenuation formula: 1.0 means never attenuate, 0.0 is complete attenuation |
linear | The linear factor in the attenuation formula: 1 means attenuate evenly over the distance |
quadratic | The quadratic factor in the attenuation formula: adds a curvature to the attenuation formula. |
|
inlineinherited |
Sets whether or not this object will cast shadows.
Definition at line 519 of file OgreMovableObject.h.
Sets a custom parameter for this Light, which may be used to drive calculations for this specific Renderable, like GPU program parameters.
index | The index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_LIGHT_CUSTOM entry, if that is used. |
value | The value to associate. |
|
inherited |
Set this light to use a custom shadow camera when rendering texture shadows.
|
inlinevirtualinherited |
Sets whether or not the debug display of this object is enabled.
Definition at line 563 of file OgreMovableObject.h.
|
inlinestaticinherited |
Set the default query flags for all future MovableObject instances.
Definition at line 407 of file OgreMovableObject.h.
|
inlinestaticinherited |
Set the default visibility flags for all future MovableObject instances.
Definition at line 435 of file OgreMovableObject.h.
Sets the colour of the diffuse light given off by this source.
|
inherited |
Sets the colour of the diffuse light given off by this source.
Sets the direction in which a light points.
|
inherited |
Sets the direction in which a light points.
|
virtualinherited |
Set a bitwise mask which will filter the lights affecting this object.
|
inlinevirtualinherited |
Sets a listener for this object.
Definition at line 446 of file OgreMovableObject.h.
Sets the position of the light.
|
inherited |
Sets the position of the light.
|
inherited |
Set a scaling factor to indicate the relative power of a light.
power | The power rating of this light, default is 1.0. |
|
inlinevirtualinherited |
Sets the query flags for this object.
Definition at line 392 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets the distance at which the object is no longer rendered.
dist | Distance beyond which the object will not be rendered (the default is 0, which means objects are always rendered). |
Definition at line 299 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.
pixelSize | Number of minimum pixels (the default is 0, which means objects are always rendered). |
Definition at line 312 of file OgreMovableObject.h.
|
virtualinherited |
Sets the render queue group this entity will be rendered through.
queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here. |
Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.
|
virtualinherited |
Sets the render queue group and group priority this entity will be rendered through.
queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here. |
priority | The priority within a group to use. |
Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.
|
inlineinherited |
Set the far clip plane distance to be used by the shadow camera, if this light casts texture shadows.
far | The distance, or -1 to use the main camera setting |
Definition at line 457 of file OgreLight.h.
|
inherited |
Sets the maximum distance away from the camera that shadows by this light will be visible.
|
inlineinherited |
Set the near clip plane distance to be used by the shadow camera, if this light casts texture shadows.
near | The distance, or -1 to use the main camera setting |
Definition at line 436 of file OgreLight.h.
Sets the colour of the specular light given off by this source.
|
inherited |
Sets the colour of the specular light given off by this source.
|
inherited |
Sets the falloff between the inner and outer cones of the spotlight.
|
inherited |
Sets the angle covered by the spotlights inner cone.
|
inlineinherited |
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.
near | The near distance |
Definition at line 286 of file OgreLight.h.
|
inherited |
Sets the angle covered by the spotlights outer cone.
|
inherited |
Sets the range of a spotlight, i.e.
the angle of the inner and outer cones and the rate of falloff between them.
innerAngle | Angle covered by the bright inner cone The inner cone applicable only to Direct3D, it'll always treat as zero in OpenGL. |
outerAngle | Angle covered by the outer cone |
falloff | The rate of falloff between the inner and outer cones. 1.0 means a linear falloff, less means slower falloff, higher means faster falloff. |
|
inherited |
Sets the type of light - see LightTypes for more info.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
Definition at line 329 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets the visiblity flags for this object.
Definition at line 420 of file OgreMovableObject.h.
|
virtualinherited |
Overridden from MovableObject.
Reimplemented from Ogre::MovableObject.
|
protectedvirtualinherited |
internal method for synchronising with parent node (if any)
|
protectedvirtualinherited |
Tells the caster to perform the tasks necessary to update the edge data's light listing.
Can be overridden if the subclass needs to do additional things.
edgeData | The edge information to update |
lightPos | 4D vector representing the light, a directional light has w=0.0 |
void Ogre::PCZLight::updateZones | ( | PCZone * | defaultZone, |
unsigned long | frameCount | ||
) |
Update the list of zones the light affects.
|
virtualinherited |
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.
visitor | Pointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this. |
debugRenderables | If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too. |
Implements Ogre::MovableObject.
|
protected |
List of PCZones which are affected by the light.
Definition at line 113 of file OgrePCZLight.h.
|
protected |
flag indicating if any of the zones in the affectedZonesList is visible in the current frame
Definition at line 109 of file OgrePCZLight.h.
|
protectedinherited |
Definition at line 543 of file OgreLight.h.
|
protectedinherited |
Definition at line 544 of file OgreLight.h.
|
protectedinherited |
Definition at line 545 of file OgreLight.h.
|
protectedinherited |
Hidden because of distance?
Definition at line 128 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 561 of file OgreLight.h.
|
protectedinherited |
Does this object cast shadows?
Definition at line 150 of file OgreMovableObject.h.
|
protectedinherited |
Creator of this object (if created by a factory)
Definition at line 112 of file OgreMovableObject.h.
|
protectedinherited |
Stores the custom parameters for the light.
Definition at line 576 of file OgreLight.h.
|
mutableprotectedinherited |
Pointer to a custom shadow camera setup.
Definition at line 572 of file OgreLight.h.
|
protectedinherited |
Is debug display enabled?
Definition at line 121 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Definition at line 560 of file OgreLight.h.
|
mutableprotectedinherited |
Definition at line 559 of file OgreLight.h.
|
mutableprotectedinherited |
Definition at line 557 of file OgreLight.h.
|
mutableprotectedinherited |
Definition at line 556 of file OgreLight.h.
|
mutableprotectedinherited |
Is the derived transform dirty?
Definition at line 569 of file OgreLight.h.
|
protectedinherited |
Definition at line 533 of file OgreLight.h.
|
protectedinherited |
Definition at line 536 of file OgreLight.h.
|
mutableprotectedinherited |
Definition at line 567 of file OgreLight.h.
|
protectedinherited |
Definition at line 547 of file OgreLight.h.
|
mutableprotectedinherited |
List of lights for this object.
Definition at line 158 of file OgreMovableObject.h.
|
mutableprotectedinherited |
The last frame that this light list was updated in.
Definition at line 160 of file OgreMovableObject.h.
|
protectedinherited |
the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable
Definition at line 163 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 531 of file OgreLight.h.
|
protectedinherited |
MovableObject listener - only one allowed (no list) for size & performance reasons. */.
Definition at line 155 of file OgreMovableObject.h.
|
protectedinherited |
SceneManager holding this object (if applicable)
Definition at line 114 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 126 of file OgreMovableObject.h.
|
protectedinherited |
Name of this object.
Definition at line 110 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Definition at line 566 of file OgreLight.h.
|
protected |
Definition at line 116 of file OgrePCZLight.h.
|
protectedinherited |
Definition at line 548 of file OgreLight.h.
|
protectedinherited |
Definition at line 117 of file OgreMovableObject.h.
|
protectedinherited |
node to which this object is attached
Definition at line 116 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 532 of file OgreLight.h.
|
protectedinherited |
Definition at line 546 of file OgreLight.h.
|
protectedinherited |
Flags determining whether this object is included / excluded from scene queries.
Definition at line 140 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 542 of file OgreLight.h.
|
protectedinherited |
Does rendering this object disabled by listener?
Definition at line 153 of file OgreMovableObject.h.
|
protectedinherited |
The render queue to use when rendering this object.
Definition at line 132 of file OgreMovableObject.h.
|
protectedinherited |
Flags whether the RenderQueue's default should be used.
Definition at line 134 of file OgreMovableObject.h.
|
protectedinherited |
The render queue group to use when rendering this object.
Definition at line 136 of file OgreMovableObject.h.
|
protectedinherited |
Flags whether the RenderQueue's default should be used.
Definition at line 138 of file OgreMovableObject.h.
|
staticprotectedinherited |
Static map of class name to list of animable value names.
Definition at line 243 of file OgreAnimable.h.
|
staticprotectedinherited |
Default query flags.
Definition at line 167 of file OgreMovableObject.h.
|
staticprotectedinherited |
Default visibility flags.
Definition at line 169 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 553 of file OgreLight.h.
|
protectedinherited |
Definition at line 549 of file OgreLight.h.
|
protectedinherited |
Definition at line 550 of file OgreLight.h.
|
protectedinherited |
Definition at line 552 of file OgreLight.h.
|
staticprotectedinherited |
Shared class-level name for Movable type.
Definition at line 564 of file OgreLight.h.
|
protectedinherited |
Definition at line 534 of file OgreLight.h.
|
protectedinherited |
Definition at line 540 of file OgreLight.h.
|
protectedinherited |
Definition at line 539 of file OgreLight.h.
|
protectedinherited |
Definition at line 541 of file OgreLight.h.
|
protectedinherited |
Definition at line 538 of file OgreLight.h.
|
protectedinherited |
Definition at line 124 of file OgreMovableObject.h.
|
protectedinherited |
Upper distance to still render.
Definition at line 123 of file OgreMovableObject.h.
|
protectedinherited |
User objects binding.
Definition at line 130 of file OgreMovableObject.h.
|
protectedinherited |
Flags determining whether this object is visible (compared to SceneManager mask)
Definition at line 142 of file OgreMovableObject.h.
|
protectedinherited |
Is this object visible?
Definition at line 119 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Cached world AABB of this object.
Definition at line 144 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Definition at line 146 of file OgreMovableObject.h.
|
mutableprotectedinherited |
World space AABB of this object's dark cap.
Definition at line 148 of file OgreMovableObject.h.
|
inherited |
Temp tag used for sorting.
Definition at line 77 of file OgreLight.h.