Ptr Class
This element is not available using the selected API.
Ptr Class
Smart pointer class used by the Carmenta Engine C++ API.
Namespace: Carmenta::Engine
Include: <Carmenta/Engine/Core.hpp>
Dynamic link library: CECore.Cpp64.dll
Library: CECore.Cpp64.lib
Include: <Carmenta/Engine/Core.hpp>
Dynamic link library: CECore.Cpp64.dll
Library: CECore.Cpp64.lib
Thread safety: Members defined in this type are, in general, not thread-safe.
Syntax
template< class T >
class Ptr;Type Parameters
T
A pointer to a Carmenta Engine reference type or interface.
Remarks
This template class is a smart pointer that the Carmenta Engine C++ API uses to pass and return Carmenta Engine reference types. The Ptr template should not be used explicitly in code. Instead, use the typedefs that Carmenta Engine C++ API provides.
// All Carmenta Engine reference types have a corresponding typedef that
// has the same name as the type with a "Ptr" suffix:
BitmapDrawablePtr drawable = new BitmapDrawable(200, 200);
ViewPtr view = new View(drawable);
// Downcasting, casting from a base class to a derived class, is done
// with the normal C++ dynamic_cast operator like the following example
// shows. Note that we must call get() since dynamic_cast works on raw
// pointers.
ConfigurationPtr config = new Configuration("Map.px");
EngineObjectPtr obj = config->getPublicObject("View0");
ViewPtr view = dynamic_cast<View*>(obj.get());
// You can also cast a return value in one step:
view = dynamic_cast<View*>(config->getPublicObject("View0").get());
Platforms
Windows, Linux, Android
Ptr Members
The Ptr type has the following members.
Constructors
| Name | Description |
|---|---|
| Ptr | Initializes a new instance of the Ptr class. |
Methods
| Name | Description |
|---|---|
| get | Gets the raw pointer that this smart pointer holds. |
| operator bool() | Checks if this smart pointer holds a pointer. |
| operator-> | Gets the raw pointer that this smart pointer holds. |
 operator!= | Checks if two smart pointers refer to different objects. |
| operator* | Gets a reference to the object this smart pointer holds a pointer to. |
| operator< | Checks if one smart pointer is less than another smart pointer. |
| operator= | Overloaded. Assigns the specified smart pointer to this instance. |
| operator== | Checks if two smart pointers refer to the same object. |
| reset | Resets this smart pointer to a null pointer. |
| swap | Overloaded. Swaps the state with another smart pointer of the same type. |