GU_AgentCustomDataItem.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 */

#ifndef __GU_AgentCustomData__
#define __GU_AgentCustomData__

#include "GU_API.h"

#include <UT/UT_IntrusivePtr.h>
#include <UT/UT_StringHolder.h>

class GU_AgentDefinition;
class UT_JSONParser;
class UT_JSONWriter;

class GU_AgentCustomDataItem;
using GU_AgentCustomDataItemPtr = UT_IntrusivePtr<GU_AgentCustomDataItem>;
using GU_AgentCustomDataItemConstPtr =
    UT_IntrusivePtr<const GU_AgentCustomDataItem>;

/// A custom data item that can be added to a GU_AgentDefinition.
///
/// Custom data item types are registered by calling
/// GU_AgentDefinition::registerCustomDataItemType() from the
/// GUregisterAgentCustomDataItemType() entry point.
class GU_API GU_AgentCustomDataItem
    : public UT_IntrusiveRefCounter<GU_AgentCustomDataItem>
{
public:
    virtual ~GU_AgentCustomDataItem() = default;

    /// Unique identifier for the data item type, used when serializing to a
    /// geometry file. This should correspond to the identifier passed to
    /// GU_AgentDefinition::registerCustomDataItemType().
    virtual const UT_StringHolder &dataItemType() const = 0;

    /// Name of the data item, used by GU_AgentDefinition when inserting or
    /// search for an item. This varies per instance, unlike dataItemType().
    virtual const UT_StringHolder &name() const = 0;

    /// The amount of memory used by this item.
    virtual int64 getMemoryUsage(bool inclusive) const = 0;

    /// Load the data from JSON.
    virtual bool load(UT_JSONParser &p) = 0;

    /// Save the data to JSON.
    virtual bool save(UT_JSONWriter &w) const = 0;
};

#endif