Files
o3de/Gems/EMotionFX/Code/MCore/Source/AttributePointer.h
T
2021-03-08 14:30:57 -08:00

88 lines
3.3 KiB
C++

/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
#pragma once
// include the required headers
#include "StandardHeaders.h"
#include "Attribute.h"
#include <MCore/Source/LogManager.h>
namespace MCore
{
/**
* The pointer attribute class.
* This attribute represents a pointer to an object. It cannot be loaded or saved to streams/files.
* It is mainly used to temporarily store pointers to objects.
*/
class MCORE_API AttributePointer
: public Attribute
{
AZ_CLASS_ALLOCATOR(AttributePointer, AttributeAllocator, 0)
friend class AttributeFactory;
public:
enum
{
TYPE_ID = 0x0000000c
};
static AttributePointer* Create(void* value = nullptr);
// adjust values
MCORE_INLINE void* GetValue() const { return mValue; }
MCORE_INLINE void SetValue(void* value) { mValue = value; }
// overloaded from the attribute base class
Attribute* Clone() const override { return AttributePointer::Create(mValue); }
const char* GetTypeString() const override { return "AttributePointer"; }
bool InitFrom(const Attribute* other) override
{
if (other->GetType() != TYPE_ID)
{
return false;
}
mValue = static_cast<const AttributePointer*>(other)->GetValue();
return true;
}
bool InitFromString(const AZStd::string& valueString) override { MCORE_UNUSED(valueString); MCORE_ASSERT(false); return false; } // currently unsupported
bool ConvertToString(AZStd::string& outString) const override { MCORE_UNUSED(outString); MCORE_ASSERT(false); return false; } // currently unsupported
uint32 GetClassSize() const override { return sizeof(AttributePointer); }
uint32 GetDefaultInterfaceType() const override { return ATTRIBUTE_INTERFACETYPE_DEFAULT; }
private:
void* mValue; /**< The pointer value. */
AttributePointer()
: Attribute(TYPE_ID)
, mValue(nullptr) { }
AttributePointer(void* pointer)
: Attribute(TYPE_ID)
, mValue(pointer) { }
~AttributePointer() {}
uint32 GetDataSize() const override { return sizeof(void*); }
// read from a stream
bool ReadData(MCore::Stream* stream, MCore::Endian::EEndianType streamEndianType, uint8 version) override
{
MCORE_UNUSED(stream);
MCORE_UNUSED(streamEndianType);
MCORE_UNUSED(version);
MCore::LogWarning("MCore::AttributePointer::ReadData() - Pointer attributes cannot be read from disk.");
return false;
}
};
} // namespace MCore