TMotion.h

Engine/source/Verve/Torque/TMotion.h

More...

Namespaces:

namespace

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Verve
 4// Copyright (C) 2014 - Violent Tulip
 5//
 6// Permission is hereby granted, free of charge, to any person obtaining a copy
 7// of this software and associated documentation files (the "Software"), to
 8// deal in the Software without restriction, including without limitation the
 9// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10// sell copies of the Software, and to permit persons to whom the Software is
11// furnished to do so, subject to the following conditions:
12//
13// The above copyright notice and this permission notice shall be included in
14// all copies or substantial portions of the Software.
15//
16// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22// IN THE SOFTWARE.
23//-----------------------------------------------------------------------------
24#ifndef _VT_TORQUE_MOTION_H_
25#define _VT_TORQUE_MOTION_H_
26
27#ifndef _VT_TORQUE_SCENEOBJECT_H_
28#include "Verve/Torque/TSceneObject.h"
29#endif
30
31#ifndef _VT_VPATH_H_
32#include "Verve/VPath/VPath.h"
33#endif
34
35namespace VTorque
36{
37    typedef VPath   PathObjectType;
38
39    bool            isMovable( SimObject *pObject );
40    bool            isPath( SimObject *pObject );
41    bool            isPathObjectAttached( PathObjectType *pPath, SceneObjectType *pObject );
42
43    F32             getPathNodeLength( PathObjectType *pPath, const S32 &pNode );
44
45    void            attachPathObject( PathObjectType *pPath, SceneObjectType *pObject, const bool &pForward, const bool &pRelative, const S32 &pStartNodeIndex, const S32 &pEndNodeIndex, const String &pOrientation, const String &pOrientationData );
46    void            detachPathObject( PathObjectType *pPath, SceneObjectType *pObject );
47
48    void            setPathObjectActive( PathObjectType *pPath, SceneObjectType *pObject, const bool &pActive );
49    void            setPathObjectInterp( PathObjectType *pPath, SceneObjectType *pObject, const F32 &pInterp );
50    void            setPathObjectOffset( PathObjectType *pPath, SceneObjectType *pObject, const Point3F &pOffset );
51    void            setPathObjectSpeed( PathObjectType *pPath, SceneObjectType *pObject, const F32 &pSpeed );
52    void            setPathObjectOrientation( PathObjectType *pPath, SceneObjectType *pObject, const String &pOrientation, const String &pOrientationData = String::EmptyString );
53    void            setPathObjectForward( PathObjectType *pPath, SceneObjectType *pObject, const bool &pForward );
54    void            setPathObjectNode( PathObjectType *pPath, SceneObjectType *pObject, const S32 &pNode );
55    void            setPathObjectEndNode( PathObjectType *pPath, SceneObjectType *pObject, const S32 &pNode );
56};
57
58#endif // _VT_TORQUE_MOTION_H_
59