OgreTagPoint.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 __TagPoint_H_
29#define __TagPoint_H_
30
31#include "OgrePrerequisites.h"
32
33#include "OgreBone.h"
34#include "OgreMatrix4.h"
35
36namespace Ogre {
37
38
39
60 class _OgreExport TagPoint : public Bone
61 {
62
63 public:
64 TagPoint(unsigned short handle, Skeleton* creator);
65 virtual ~TagPoint();
66
67 Entity *getParentEntity(void) const;
69
70 void setParentEntity(Entity *pEntity);
72
78
82
87 void setInheritParentEntityScale(bool inherit);
88
92
95
97 const Matrix4& _getFullLocalTransform(void) const;
98
100 void needUpdate(bool forceParentUpdate = false);
101
103 void updateFromParentImpl(void) const;
105 const LightList& getLights(void) const;
106
107
108
109 private:
115 };
116
120} //namespace
121
122
123#endif//__TagPoint_H_
#define _OgreExport
Definition: OgrePlatform.h:257
A bone in a skeleton.
Definition: OgreBone.h:52
Defines an instance of a discrete, movable object based on a Mesh.
Definition: OgreEntity.h:83
Class encapsulating a standard 4x4 homogeneous matrix.
Definition: OgreMatrix4.h:79
Abstract class defining a movable object in a scene.
A collection of Bone objects used to animate a skinned mesh.
Definition: OgreSkeleton.h:88
A tagged point on a skeleton, which can be used to attach entities to on specific other entities.
Definition: OgreTagPoint.h:61
bool getInheritParentEntityOrientation(void) const
Returns true if this TagPoint is affected by orientation applied to the parent entity.
Entity * mParentEntity
Definition: OgreTagPoint.h:110
Matrix4 mFullLocalTransform
Definition: OgreTagPoint.h:112
bool getInheritParentEntityScale(void) const
Returns true if this TagPoint is affected by scaling factors applied to the parent entity.
MovableObject * mChildObject
Definition: OgreTagPoint.h:111
bool mInheritParentEntityScale
Definition: OgreTagPoint.h:114
Entity * getParentEntity(void) const
bool mInheritParentEntityOrientation
Definition: OgreTagPoint.h:113
const Matrix4 & getParentEntityTransform(void) const
Gets the transform of parent entity.
void setInheritParentEntityOrientation(bool inherit)
Tells the TagPoint whether it should inherit orientation from it's parent entity.
TagPoint(unsigned short handle, Skeleton *creator)
MovableObject * getChildObject(void) const
void needUpdate(bool forceParentUpdate=false)
To be called in the event of transform changes to this node that require it's recalculation.
void setChildObject(MovableObject *pObject)
virtual ~TagPoint()
void setInheritParentEntityScale(bool inherit)
Tells the TagPoint whether it should inherit scaling factors from it's parent entity.
const Matrix4 & _getFullLocalTransform(void) const
Gets the transform of this node just for the skeleton (not entity)
void updateFromParentImpl(void) const
Overridden from Node in order to include parent Entity transform.
void setParentEntity(Entity *pEntity)
const LightList & getLights(void) const
Gets a list of lights, ordered relative to how close they are to this renderable.

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