OgreSimpleRenderable.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2013 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE SOFTWARE.
26-----------------------------------------------------------------------------
27*/
28#ifndef __SimpleRenderable_H__
29#define __SimpleRenderable_H__
30
31#include "OgrePrerequisites.h"
32
33#include "OgreMovableObject.h"
34#include "OgreRenderable.h"
35#include "OgreAxisAlignedBox.h"
36#include "OgreMaterial.h"
37#include "OgreHeaderPrefix.h"
38
39namespace Ogre {
40
51 {
52 protected:
54
57
60
63
66
69
70 public:
73
76
77 virtual void setMaterial( const String& matName );
78 virtual const MaterialPtr& getMaterial(void) const;
79
80 virtual void setRenderOperation( const RenderOperation& rend );
82
84 virtual void getWorldTransforms( Matrix4* xform ) const;
85
86
88
90 virtual const AxisAlignedBox& getBoundingBox(void) const;
91
95 bool debugRenderables = false);
96
98
99
101 virtual const String& getMovableType(void) const;
102
104 const LightList& getLights(void) const;
105
106 };
109}
110
111#include "OgreHeaderSuffix.h"
112
113#endif
114
#define _OgreExport
A 3D box aligned with the x/y/z axes.
A viewpoint from which the scene will be rendered.
Definition OgreCamera.h:87
Class encapsulating a standard 4x4 homogeneous matrix.
Definition OgreMatrix4.h:79
Abstract class defining a movable object in a scene.
'New' rendering operation using vertex buffers.
Class to manage the scene object rendering queue.
Visitor object that can be used to iterate over a collection of Renderable instances abstractly.
Abstract class defining the interface all renderable objects must implement.
Manages the organisation and rendering of a 'scene' i.e.
Simple implementation of MovableObject and Renderable for single-part custom objects.
SimpleRenderable(const String &name)
Named constructor.
virtual const MaterialPtr & getMaterial(void) const
Retrieves a weak reference to the material this renderable object uses.
void setWorldTransform(const Matrix4 &xform)
void setBoundingBox(const AxisAlignedBox &box)
static uint msGenNameCount
Static member used to automatically generate names for SimpleRendaerable objects.
void visitRenderables(Renderable::Visitor *visitor, bool debugRenderables=false)
Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject ...
virtual void setMaterial(const String &matName)
const LightList & getLights(void) const
Gets a list of lights, ordered relative to how close they are to this renderable.
virtual void _updateRenderQueue(RenderQueue *queue)
Internal method by which the movable object must add Renderable subclass instances to the rendering q...
virtual void _notifyCurrentCamera(Camera *cam)
Internal method to notify the object of the camera to be used for the next rendering operation.
virtual void getRenderOperation(RenderOperation &op)
Gets the render operation required to send this object to the frame buffer.
SimpleRenderable()
Constructor.
virtual const AxisAlignedBox & getBoundingBox(void) const
Retrieves the local axis-aligned bounding box for this object.
virtual void setRenderOperation(const RenderOperation &rend)
virtual void getWorldTransforms(Matrix4 *xform) const
Gets the world transform matrix / matrices for this renderable object.
SceneManager * mParentSceneManager
The scene manager for the current frame.
virtual const String & getMovableType(void) const
Overridden from MovableObject.
Camera * mCamera
The camera for the current frame.
unsigned int uint
_StringBase String

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.