RamsesCameraBinding

class rlogic::RamsesCameraBinding : public rlogic::RamsesBinding

The RamsesCameraBinding is a type of rlogic::RamsesBinding which allows the rlogic::LogicEngine to control instances of ramses::Camera. RamsesCameraBinding’s can be created with rlogic::LogicEngine::createRamsesCameraBinding or rlogic::LogicEngine::createRamsesCameraBindingWithFrustumPlanes, which affects the set of input properties that will be used to control camera frustum as described below.

The RamsesCameraBinding has a static link to a ramses::Camera. After creation, rlogic::LogicNode::getInputs will return a struct property with children equivalent to the camera settings of the provided ramses::Camera.

There are two types of ramses::Camera:

  • ramses::PerspectiveCamera

  • ramses::OrthographicCamera

Both camera types are defined through their viewport and their frustum properties. These are represented as two separate property structs in the RamsesCameraBinding. Be aware if you set one or more values to one of the structs on the binding and update the LogicEngine it will lead to all properties of this struct being set on the actual ramses::Camera. For example if you only set the ‘offsetX’ of the Camera viewport it will set all other viewport properties as well (offsetY, width and height) to whatever their state is at that moment. The values of the RamsesCameraBinding inputs are initialized with the values of the provided ramses::Camera during creation. The frustum values of the ramses::Camera are not affected when setting viewport values, and vice-versa. Check the ramses::Camera API to see which values belong together. To avoid unexpected behavior, we highly recommend setting all viewport values together, and also setting all frustum planes together (either by link or by setting them directly). This way unwanted behavior can be avoided.

Since the RamsesCameraBinding derives from rlogic::RamsesBinding, it also provides the rlogic::LogicNode::getInputs and rlogic::LogicNode::getOutputs method. For this class, the methods behave as follows:

  • rlogic::LogicNode::getInputs: returns inputs struct with two child properties: viewport and frustum.

    • ’viewport’ (type struct) with these children:

      • ’offsetX’ (type Int32) - viewport offset horizontal

      • ’offsetY’ (type Int32) - viewport offset vertical

      • ’width’ (type Int32) - viewport width

      • ’height’ (type Int32) - viewport height

    • ’frustum’ (type struct) children vary depending on frustum parameters to use, it will be one of the following sets of parameters:

      • full set of frustum plane properties:

        • ’nearPlane’ (type Float) - frustum plane near

        • ’farPlane’ (type Float) - frustum plane far

        • ’leftPlane’ (type Float) - frustum plane left

        • ’rightPlane’ (type Float) - frustum plane right

        • ’bottomPlane’ (type Float) - frustum plane bottom

        • ’topPlane’ (type Float) - frustum plane top

      • simplified set of frustum properties:

        • ’nearPlane’ (type Float) - frustum plane near

        • ’farPlane’ (type Float) - frustum plane far

        • ’fieldOfView’ (type Float) - frustum field of view in degrees

        • ’aspectRatio’ (type Float) - aspect ratio of frustum width / frustum height Full set of frustum planes properties will be present if camera is ramses::Orthographic (regardless of which create method was used) or camera is ramses::PerspectiveCamera and rlogic::LogicEngine::createRamsesCameraBindingWithFrustumPlanes was used to create it. Simplified set of frustum properties will be present if camera is ramses::PerspectiveCamera and rlogic::LogicEngine::createRamsesCameraBinding was used to create it. Refer to ramses::Camera, ramses::PerspectiveCamera and ramses::OrthographicCamera for meaning and constraints of all these inputs.

  • rlogic::LogicNode::getOutputs: returns always nullptr, because a RamsesCameraBinding does not have outputs, it implicitly controls the ramses Camera

Public Functions

ramses::Camera &getRamsesCamera() const

Returns the bound ramses camera.

Return

the bound ramses camera

RamsesCameraBinding(std::unique_ptr<internal::RamsesCameraBindingImpl> impl) noexcept

Constructor of RamsesCameraBinding. User is not supposed to call this - RamsesCameraBindings are created by other factory classes

Parameters

~RamsesCameraBinding() noexcept override

Destructor of RamsesCameraBinding.

RamsesCameraBinding(const RamsesCameraBinding &other) = delete

Copy Constructor of RamsesCameraBinding is deleted because RamsesCameraBindings are not supposed to be copied

Parameters

  • other: RamsesNodeBindings to copy from

RamsesCameraBinding(RamsesCameraBinding &&other) = delete

Move Constructor of RamsesCameraBinding is deleted because RamsesCameraBindings are not supposed to be moved

Parameters

RamsesCameraBinding &operator=(const RamsesCameraBinding &other) = delete

Assignment operator of RamsesCameraBinding is deleted because RamsesCameraBindings are not supposed to be copied

Parameters

RamsesCameraBinding &operator=(RamsesCameraBinding &&other) = delete

Move assignment operator of RamsesCameraBinding is deleted because RamsesCameraBindings are not supposed to be moved

Parameters

Public Members

internal::RamsesCameraBindingImpl &m_cameraBinding

Implementation detail of RamsesCameraBinding