RAMSES Documentation  27.0.130
Information for RAMSES users and developers
RamsesObject.h
Go to the documentation of this file.
1 // -------------------------------------------------------------------------
2 // Copyright (C) 2014 BMW Car IT GmbH
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_RAMSESOBJECT_H
10 #define RAMSES_RAMSESOBJECT_H
11 
14 
15 namespace ramses
16 {
21  {
22  public:
28  const char* getName() const;
29 
37  status_t setName(const char* name);
38 
45 
52  bool isOfType(ERamsesObjectType type) const;
53 
57  class RamsesObjectImpl& impl;
58 
59  protected:
65  explicit RamsesObject(RamsesObjectImpl& pimpl);
66 
70  virtual ~RamsesObject();
71 
72  private:
76  RamsesObject(const RamsesObject& other);
77 
84  RamsesObject& operator=(const RamsesObject& other);
85  };
86 }
87 
88 #endif
#define RAMSES_API
Definition: APIExport.h:35
The RamsesObject is a base class for all client API objects owned by the framework.
Definition: RamsesObject.h:21
status_t setName(const char *name)
Changes the name of the object.
virtual ~RamsesObject()
Destructor of the RamsesObject.
const char * getName() const
Returns the name of the object.
class RamsesObjectImpl & impl
Definition: RamsesObject.h:57
bool isOfType(ERamsesObjectType type) const
Checks if the object is of given type.
RamsesObject(RamsesObjectImpl &pimpl)
Constructor for RamsesObject.
ERamsesObjectType getType() const
Gets type of the object.
The StatusObject provides status message handling.
Definition: StatusObject.h:22
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
ERamsesObjectType
RamsesObject type ID.
Definition: RamsesObjectTypes.h:18