scg3  0.6
scg_doxygen_stub.h
Go to the documentation of this file.
1 
10 /*
11  * Copyright 2014 Volker Ahlers
12  *
13  * Licensed under the Apache License, Version 2.0 (the "License");
14  * you may not use this file except in compliance with the License.
15  * You may obtain a copy of the License at
16  *
17  * http://www.apache.org/licenses/LICENSE-2.0
18  *
19  * Unless required by applicable law or agreed to in writing, software
20  * distributed under the License is distributed on an "AS IS" BASIS,
21  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22  * See the License for the specific language governing permissions and
23  * limitations under the License.
24  */
25 
26 #ifndef SCG_DOXYGEN_STUB_H_
27 #define SCG_DOXYGEN_STUB_H_
28 
29 namespace scg {
30 
31 
36 #define SCG_DOXYGEN_STUB(TypeName) \
37  \
38  typedef TypeName##* TypeName##SP; \
39  \
40  typedef TypeName##* TypeName##UP;
41 
42 SCG_DOXYGEN_STUB(Animation);
43 SCG_DOXYGEN_STUB(BumpMapCore);
44 SCG_DOXYGEN_STUB(Camera);
45 SCG_DOXYGEN_STUB(CameraController);
46 SCG_DOXYGEN_STUB(ColorCore);
47 SCG_DOXYGEN_STUB(Composite);
48 SCG_DOXYGEN_STUB(Controller);
49 SCG_DOXYGEN_STUB(Core);
50 SCG_DOXYGEN_STUB(GeometryCore);
51 SCG_DOXYGEN_STUB(GeometryCoreFactory);
52 SCG_DOXYGEN_STUB(Group);
53 SCG_DOXYGEN_STUB(InfoTraverser);
54 SCG_DOXYGEN_STUB(KeyboardController);
55 SCG_DOXYGEN_STUB(Leaf);
56 SCG_DOXYGEN_STUB(Light);
57 SCG_DOXYGEN_STUB(LightPosition);
58 SCG_DOXYGEN_STUB(MaterialCore);
59 SCG_DOXYGEN_STUB(MouseController);
60 SCG_DOXYGEN_STUB(Node);
61 SCG_DOXYGEN_STUB(OrthographicCamera);
62 SCG_DOXYGEN_STUB(PerspectiveCamera);
63 SCG_DOXYGEN_STUB(PreTraverser);
64 SCG_DOXYGEN_STUB(Renderer);
65 SCG_DOXYGEN_STUB(RenderState);
66 SCG_DOXYGEN_STUB(RenderTraverser);
67 SCG_DOXYGEN_STUB(ShaderCore);
68 SCG_DOXYGEN_STUB(ShaderCoreFactory);
69 SCG_DOXYGEN_STUB(Shape);
70 SCG_DOXYGEN_STUB(StandardRenderer);
71 SCG_DOXYGEN_STUB(Texture2DCore);
72 SCG_DOXYGEN_STUB(TextureCore);
73 SCG_DOXYGEN_STUB(TextureCoreFactory);
74 SCG_DOXYGEN_STUB(TransformAnimation);
75 SCG_DOXYGEN_STUB(Transformation);
76 SCG_DOXYGEN_STUB(Traverser);
77 SCG_DOXYGEN_STUB(Viewer);
78 SCG_DOXYGEN_STUB(ViewState);
79 
80 
81 } // namespace scg
82 
83 #endif /* SCG_DOXYGEN_STUB_H_ */
scg::StandardRenderer
A standard renderer that uses a PreTraverser, a RenderTraverser, and an InfoTraverser.
Definition: StandardRenderer.h:42
scg::OrthographicCamera
A camera with orthographic projection(composite node).
Definition: OrthographicCamera.h:47
scg::ShaderCore
A core to set a shader program to be applied to subsequent nodes.
Definition: ShaderCore.h:69
scg::Camera
Base class for all cameras (composite node, abstract).
Definition: Camera.h:51
scg::GeometryCore
A core that contains geometry information to be rendered.
Definition: GeometryCore.h:53
scg::Composite
Base class for all composite nodes, i.e., nodes with children (composite pattern, abstract).
Definition: Composite.h:37
scg::TextureCoreFactory
A factory to create textures.
Definition: TextureCoreFactory.h:39
scg::TransformAnimation
An animation that creates a transformation to be applied to its sub-tree (composite node).
Definition: TransformAnimation.h:63
scg::Light
A light to be applied to all nodes of its sub-tree (composite node).
Definition: Light.h:54
scg::Leaf
Base class for all leaf nodes, i.e., nodes without children (composite pattern, abstract).
Definition: Leaf.h:36
scg::Viewer
Central viewer managing window, controllers, animations, and main loop.
Definition: Viewer.h:108
scg::ShaderCoreFactory
A factory to create shader cores.
Definition: ShaderCoreFactory.h:56
scg::Group
A group node to be used as root of a sub-tree of nodes (composite node).
Definition: Group.h:41
scg::Core
Base class for all cores (abstract).
Definition: Core.h:36
scg::KeyboardController
A camera controller using keyboard input.
Definition: KeyboardController.h:41
scg::RenderTraverser
A traverser that renders the scene graph (visitor pattern).
Definition: RenderTraverser.h:43
scg::PerspectiveCamera
A camera with perspective projection (composite node).
Definition: PerspectiveCamera.h:44
scg::TextureCore
Base class for all texture cores (abstract).
Definition: TextureCore.h:39
scg::Traverser
Base class for all traversers (visitor pattern, abstract).
Definition: Traverser.h:36
scg::CameraController
Base class for all camera controllers, acting on a Camera node (abstract).
Definition: CameraController.h:43
scg::Texture2DCore
2D texture core.
Definition: Texture2DCore.h:39
scg::ColorCore
A core to set a vertex color or a color transformation to be applied to subsequent geometry.
Definition: ColorCore.h:40
scg::InfoTraverser
A traverser that gathers information about the scene graph (visitor pattern).
Definition: InfoTraverser.h:37
scg::MaterialCore
A core to set material properties for lighting to be applied to subsequent geometry.
Definition: MaterialCore.h:44
SCG_DOXYGEN_STUB
#define SCG_DOXYGEN_STUB(TypeName)
C++11 smart pointer class definition stubs required by doxygen to generate correct collaboration diag...
Definition: scg_doxygen_stub.h:36
scg::Shape
A shape node that contains geometry to be rendered (leaf node).
Definition: Shape.h:42
scg::Animation
Base class for all animations (abstract), providing general functionality.
Definition: Animation.h:34
scg::MouseController
A camera controller using mouse input.
Definition: MouseController.h:40
scg::ViewState
The view state of the application, managed by Viewer and accessible by Controller::checkInput() (or d...
Definition: ViewState.h:39
scg::PreTraverser
A traverser that searches Camera and LightPosition nodes in the scene graph (visitor pattern).
Definition: PreTraverser.h:37
scg::RenderState
The central render state that collects information about the current shader, transformations,...
Definition: RenderState.h:107
scg::BumpMapCore
2D bump map core storing a texture (optional) and a normal map.
Definition: BumpMapCore.h:37
scg::Transformation
A transformation node to be used to appy a transformation to the sub-tree (composite node).
Definition: Transformation.h:42
scg::GeometryCoreFactory
A factory to create geometry cores.
Definition: GeometryCoreFactory.h:40
scg
Definition: Animation.h:28
scg::Node
Base class for all nodes (composite pattern, abstract).
Definition: Node.h:47
scg::LightPosition
A light position node to define the position of an associated light within the scene graph (leaf node...
Definition: LightPosition.h:44
scg::Controller
Base class for all controllers (abstract).
Definition: Controller.h:36
scg::Renderer
Base class for all renderers (abstract).
Definition: Renderer.h:45