Helper class to create strongly typed values out of various types.
More...
#include <StronglyTypedValue.h>
template<typename _baseType, _baseType _invalid, typename _uniqueId>
class ramses::StronglyTypedValue< _baseType, _invalid, _uniqueId >
Helper class to create strongly typed values out of various types.
- Examples
- ramses-example-basic-animation-realtime/src/main.cpp, ramses-example-basic-animation/src/main.cpp, ramses-example-basic-blending/src/main.cpp, ramses-example-basic-compositing/src/main.cpp, ramses-example-basic-effect-from-glsl/src/main.cpp, ramses-example-basic-file-loading/src/main.cpp, ramses-example-basic-geometry/src/main.cpp, ramses-example-basic-rendergroups/src/main.cpp, ramses-example-basic-renderpasses/src/main.cpp, ramses-example-basic-rendertarget/src/main.cpp, ramses-example-basic-scenegraph/src/main.cpp, ramses-example-basic-texturing/src/main.cpp, ramses-example-data-buffers-texture/src/main.cpp, ramses-example-data-buffers-vertices/src/main.cpp, ramses-example-dcsm-provider/src/main.cpp, ramses-example-geometry-instancing/src/main.cpp, ramses-example-interleaved-vertex-buffers/src/main.cpp, ramses-example-local-client-dcsm/src/main.cpp, ramses-example-local-client/src/main.cpp, ramses-example-local-datalink/src/main.cpp, ramses-example-local-displays/src/main.cpp, ramses-example-local-dma-offscreenbuffer/src/main.cpp, ramses-example-local-geometry-shaders/src/main.cpp, ramses-example-local-offscreenbuffer/src/main.cpp, ramses-example-local-pick-handling/src/main.cpp, ramses-example-local-scene-referencing/src/main.cpp, ramses-example-local-viewport-link/src/main.cpp, ramses-example-minimal/src/main.cpp, ramses-example-renderonce/src/main.cpp, ramses-example-text-basic/src/main.cpp, and ramses-example-text-languages/src/main.cpp.
◆ BaseType
template<typename _baseType , _baseType _invalid, typename _uniqueId >
The underlying type of the class.
◆ StronglyTypedValue() [1/3]
template<typename _baseType , _baseType _invalid, typename _uniqueId >
Constructor based on the underlying type.
- Parameters
-
| value | The initial value of the underlying type in the object |
◆ StronglyTypedValue() [2/3]
template<typename _baseType , _baseType _invalid, typename _uniqueId >
Default constructor with invalid value.
◆ StronglyTypedValue() [3/3]
template<typename _baseType , _baseType _invalid, typename _uniqueId >
Copy constructor.
- Parameters
-
| other | The object to be copied |
◆ getReference()
template<typename _baseType , _baseType _invalid, typename _uniqueId >
Getter for a reference of the underlying value.
- Returns
- Reference of the underlying value of the object
◆ getValue()
template<typename _baseType , _baseType _invalid, typename _uniqueId >
◆ Invalid()
template<typename _baseType , _baseType _invalid, typename _uniqueId >
Static Getter for Invalid.
- Returns
- Invalid Value of the underlying type
◆ isValid()
template<typename _baseType , _baseType _invalid, typename _uniqueId >
Predicate to check value is unequal to Invalid() value.
- Returns
- true when valid (i.e. not Invalid()), false otherwise
◆ operator!=()
template<typename _baseType , _baseType _invalid, typename _uniqueId >
Not equals operator, compares the object to another.
- Parameters
-
| other | The object to compare to |
- Returns
- False if the underlying value of the object equals to the underlying value of the other.
◆ operator=()
template<typename _baseType , _baseType _invalid, typename _uniqueId >
Assignment operator.
- Parameters
-
| other | The object to copy the value from |
- Returns
- A reference to this object.
◆ operator==()
template<typename _baseType , _baseType _invalid, typename _uniqueId >
Equals operator, compares the object to another.
- Parameters
-
| other | The object to compare to |
- Returns
- True if the underlying value of the object equals to the underlying value of the other.
The documentation for this class was generated from the following file:
- /home/runner/work/ramses/ramses/framework/ramses-framework-api/include/ramses-framework-api/StronglyTypedValue.h
1.9.1