Ocean
Loading...
Searching...
No Matches
HeadUpTransform.h
Go to the documentation of this file.
1/*
2 * Copyright (c) Meta Platforms, Inc. and affiliates.
3 *
4 * This source code is licensed under the MIT license found in the
5 * LICENSE file in the root directory of this source tree.
6 */
7
8#ifndef META_OCEAN_SCENEDESCRIPTION_SDX_X3D_HEAD_UP_TRANSFORM_H
9#define META_OCEAN_SCENEDESCRIPTION_SDX_X3D_HEAD_UP_TRANSFORM_H
10
13
15
16namespace Ocean
17{
18
19namespace SceneDescription
20{
21
22namespace SDX
23{
24
25namespace X3D
26{
27
28/**
29 * This class implements an ocean specific X3D node to allow head-up nodes.
30 * @ingroup scenedescriptionsdxx3d
31 */
32class OCEAN_SCENEDESCRIPTION_SDX_X3D_EXPORT HeadUpTransform : virtual public X3DGroupingNode
33{
34 public:
35
36 /**
37 * Creates a new ocean head-up transform node.
38 * @param environment Node environment
39 */
40 explicit HeadUpTransform(const SDXEnvironment* environment);
41
42 protected:
43
44 /**
45 * Destructs an ocean head-up transform node.
46 */
47 ~HeadUpTransform() override;
48
49 /**
50 * Specifies the node type and the fields of this node.
51 * @return Unique node specification of this node
52 */
54
55 /**
56 * Event function to inform the node that it has been initialized and can apply all internal values to corresponding rendering objects.
57 * @see SDXNode::onInitialize().
58 */
59 void onInitialize(const Rendering::SceneRef& scene, const Timestamp timestamp) override;
60
61 /**
62 * Event function to inform the node about a changed field.
63 * @see SDXNode::onFieldChanged().
64 */
65 void onFieldChanged(const std::string& fieldName) override;
66
67 /**
68 * Returns the address of the most derived object.
69 * @see Node::objectAddress().
70 */
71 size_t objectAddress() const override;
72
73 protected:
74
75 /// ScreenPosition Field.
77};
78
79}
80
81}
82
83}
84
85}
86
87#endif // META_OCEAN_SCENEDESCRIPTION_SDX_X3D_HEAD_UP_TRANSFORM_H
This class implements a node specification object.
Definition scenedescription/Node.h:77
This class implements an ocean specific X3D node to allow head-up nodes.
Definition HeadUpTransform.h:33
void onFieldChanged(const std::string &fieldName) override
Event function to inform the node about a changed field.
size_t objectAddress() const override
Returns the address of the most derived object.
HeadUpTransform(const SDXEnvironment *environment)
Creates a new ocean head-up transform node.
void onInitialize(const Rendering::SceneRef &scene, const Timestamp timestamp) override
Event function to inform the node that it has been initialized and can apply all internal values to c...
SingleVector2 screenPosition_
ScreenPosition Field.
Definition HeadUpTransform.h:76
~HeadUpTransform() override
Destructs an ocean head-up transform node.
NodeSpecification specifyNode()
Specifies the node type and the fields of this node.
This class implements an abstract x3d grouping node.
Definition X3DGroupingNode.h:34
This class implements a node environment container.
Definition SDXNode.h:62
This class implements a timestamp.
Definition Timestamp.h:36
The namespace covering the entire Ocean framework.
Definition Accessor.h:15