RAMSES Documentation  27.0.130
Information for RAMSES users and developers
SceneReference.h
Go to the documentation of this file.
1 // -------------------------------------------------------------------------
2 // Copyright (C) 2020 BMW AG
3 // -------------------------------------------------------------------------
4 // This Source Code Form is subject to the terms of the Mozilla Public
5 // License, v. 2.0. If a copy of the MPL was not distributed with this
6 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
7 // -------------------------------------------------------------------------
8 
9 #ifndef RAMSES_SCENEREFERENCE_H
10 #define RAMSES_SCENEREFERENCE_H
11 
14 
15 namespace ramses
16 {
37  {
38  public:
67 
73 
79 
97 
109  status_t setRenderOrder(int32_t renderOrder);
110 
114  class SceneReferenceImpl& impl;
115 
116  protected:
120  friend class SceneImpl;
121 
127  explicit SceneReference(SceneReferenceImpl& pimpl);
128 
132  virtual ~SceneReference() override;
133  };
134 }
135 
136 #endif
#define RAMSES_API
Definition: APIExport.h:35
The SceneObject is a base class for all client API objects owned by a Scene.
Definition: SceneObject.h:20
The SceneReference object refers to another ramses scene using its sceneId.
Definition: SceneReference.h:37
status_t requestNotificationsForSceneVersionTags(bool flag)
Request callbacks (ramses::IClientEventHandler::sceneReferenceFlushed) to be triggered whenever a flu...
SceneReference(SceneReferenceImpl &pimpl)
Constructor for SceneReference.
status_t requestState(RendererSceneState requestedState)
Set a requested state for this scene reference.
sceneId_t getReferencedSceneId() const
Get the sceneId of the referenced scene.
RendererSceneState getRequestedState() const
Get the currently requested state for this scene reference.
status_t setRenderOrder(int32_t renderOrder)
Set scene render order.
virtual ~SceneReference() override
Destructor of the SceneReference.
class SceneReferenceImpl & impl
Definition: SceneReference.h:114
Helper class to create strongly typed values out of various types.
Definition: StronglyTypedValue.h:23
The RAMSES namespace contains all client side objects and functions used to implement RAMSES applicat...
Definition: AnimatedProperty.h:15
uint32_t status_t
Status is a handle to the result of an API call.
Definition: RamsesFrameworkTypes.h:26
RendererSceneState
Definition: RendererSceneState.h:19