Ocean
BooleanToggle.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_BOOLEAN_TOGGLE_H
9 #define META_OCEAN_SCENEDESCRIPTION_SDX_X3D_BOOLEAN_TOGGLE_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 boolean toggle node.
28  * @ingroup scenedescriptionsdxx3d
29  */
30 class OCEAN_SCENEDESCRIPTION_SDX_X3D_EXPORT BooleanToggle : virtual public X3DChildNode
31 {
32  public:
33 
34  /**
35  * Creates a new x3d boolean toggle node.
36  * @param environment Node environment
37  */
38  explicit BooleanToggle(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  * Explicit changing event function for node fields.
50  * @see X3DNode::onFieldChanging().
51  */
52  bool onFieldChanging(const std::string& fieldName, const Field& field) override;
53 
54  /**
55  * Returns the address of the most derived object.
56  * @see Node::objectAddress().
57  */
58  size_t objectAddress() const override;
59 
60  protected:
61 
62  /// Set_boolean field.
64 
65  /// Toggle field.
67 };
68 
69 }
70 
71 }
72 
73 }
74 
75 }
76 
77 #endif // META_OCEAN_SCENEDESCRIPTION_SDX_X3D_BOOLEAN_TOGGLE_H
This class is the base class for all scene description fields.
Definition: Field.h:36
This class implements a node specification object.
Definition: scenedescription/Node.h:77
This class implements a x3d boolean toggle node.
Definition: BooleanToggle.h:31
NodeSpecification specifyNode()
Specifies the node type and the fields of this node.
bool onFieldChanging(const std::string &fieldName, const Field &field) override
Explicit changing event function for node fields.
SingleBool setBoolean_
Set_boolean field.
Definition: BooleanToggle.h:63
SingleBool toggle_
Toggle field.
Definition: BooleanToggle.h:66
size_t objectAddress() const override
Returns the address of the most derived object.
BooleanToggle(const SDXEnvironment *environment)
Creates a new x3d boolean toggle node.
This class implements an abstract x3d child node.
Definition: X3DChildNode.h:31
This class implements a node environment container.
Definition: SDXNode.h:62
The namespace covering the entire Ocean framework.
Definition: Accessor.h:15