scene_object.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 
30 #pragma once
31 
32 #include "api_scene3d.h"
33 #include <memory>
34 
35 namespace clan
36 {
39 
40 class Scene;
41 class SceneModel;
42 class SceneObject_Impl;
43 
44 class CL_API_SCENE SceneObject
45 {
46 public:
47  SceneObject();
48  SceneObject(Scene &scene, const SceneModel &model, const Vec3f &position = Vec3f(0.0f), const Quaternionf &orientation = Quaternionf(), const Vec3f &scale = Vec3f(1.0f));
49  bool is_null() const { return !impl; }
50 
51  Vec3f get_position() const;
52  Quaternionf get_orientation() const;
53  Vec3f get_scale() const;
54  void set_position(const Vec3f &position);
55  void set_orientation(const Quaternionf &orientation);
56  void set_scale(const Vec3f &scale);
57 
58  void set_light_probe_receiver(bool enable);
59 
60  // \brief Moves object relative to its current orientation
61  SceneObject &move(Vec3f offset);
62 
63  // \brief Rotate object relative to its current orientation
64  SceneObject &rotate(float dir, float up, float tilt);
65 
66  void play_animation(const std::string &name);
67  void update(float time_elapsed);
68  void moved(float units_moved);
69 
70 private:
71  std::shared_ptr<SceneObject_Impl> impl;
72 };
73 
74 }
75 
Vec3< float > Vec3f
Definition: vec3.h:427
bool is_null() const
Definition: scene_object.h:49
Definition: scene_object.h:44
Definition: scene.h:50
Definition: scene_model.h:45
Quaternion - Float.
Definition: quaternion.h:188
3D vector
Definition: line_ray.h:49