Ocean
scenedescription/sdx/x3d/DirectionalLight.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_DIRECTIONAL_LIGHT_H
9 #define META_OCEAN_SCENEDESCRIPTION_SDX_X3D_DIRECTIONAL_LIGHT_H
10 
13 
14 namespace Ocean
15 {
16 
17 namespace SceneDescription
18 {
19 
20 namespace SDX
21 {
22 
23 namespace X3D
24 {
25 
26 /**
27  * This class implements a x3d directional light node.
28  * @ingroup scenedescriptionsdxx3d
29  */
30 class OCEAN_SCENEDESCRIPTION_SDX_X3D_EXPORT DirectionalLight : virtual public X3DLightNode
31 {
32  public:
33 
34  /**
35  * Creates a new x3d directional light node.
36  * @param environment Node environment
37  */
38  explicit DirectionalLight(const SDXEnvironment* environment);
39 
40  protected:
41 
42  /**
43  * Specifies the node type and the fields of this node.
44  * @return Unique node specification of this node
45  */
47 
48  /**
49  * Event function to inform the node that it has been initialized and can apply all internal values to corresponding rendering objects.
50  * @see SDXNode::onInitialize().
51  */
52  void onInitialize(const Rendering::SceneRef& scene, const Timestamp timestamp) override;
53 
54  /**
55  * Event function to inform the node about a changed field.
56  * @see SDXNode::onFieldChanged().
57  */
58  void onFieldChanged(const std::string& fieldName) override;
59 
60  /**
61  * Event function to update the position or direction of a light source with global state.
62  * @see SDXNode::onGlobalLight().
63  */
64  void onGlobalLight(const HomogenousMatrix4& world_T_light) override;
65 
66  /**
67  * Returns the address of the most derived object.
68  * @see Node::objectAddress().
69  */
70  size_t objectAddress() const override;
71 
72  protected:
73 
74  /// Direction field.
76 };
77 
78 }
79 
80 }
81 
82 }
83 
84 }
85 
86 #endif // META_OCEAN_SCENEDESCRIPTION_SDX_X3D_DIRECTIONAL_LIGHT_H
This class implements a node specification object.
Definition: scenedescription/Node.h:77
This class implements a x3d directional light node.
Definition: scenedescription/sdx/x3d/DirectionalLight.h:31
NodeSpecification specifyNode()
Specifies the node type and the fields of this 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...
size_t objectAddress() const override
Returns the address of the most derived object.
void onFieldChanged(const std::string &fieldName) override
Event function to inform the node about a changed field.
DirectionalLight(const SDXEnvironment *environment)
Creates a new x3d directional light node.
void onGlobalLight(const HomogenousMatrix4 &world_T_light) override
Event function to update the position or direction of a light source with global state.
SingleVector3 direction_
Direction field.
Definition: scenedescription/sdx/x3d/DirectionalLight.h:75
This class implements an abstract x3d light node.
Definition: X3DLightNode.h:35
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