87 lines
3.4 KiB
C
87 lines
3.4 KiB
C
#pragma once
|
|
|
|
/// \file blueprint.h
|
|
/// \author Folling <folling@ikarus.world>
|
|
|
|
#include <ikarus/macros.h>
|
|
#include <ikarus/stdtypes.h>
|
|
|
|
/// \defgroup blueprints Blueprints
|
|
/// \brief Blueprints are templates for entities.
|
|
/// @{
|
|
|
|
IKARUS_BEGIN_HEADER
|
|
|
|
/// \brief A blueprint object.
|
|
/// \details A blueprint is a collection of properties which can be linked to entities.
|
|
/// Each entity the blueprint is linked to will have values for the blueprints properties.q
|
|
struct IkarusBlueprint;
|
|
|
|
/// \brief Creates a blueprint.
|
|
/// \param project The project the blueprint is part of.
|
|
/// \pre \li Must not be null.
|
|
/// \pre \li Must exist.
|
|
/// \param name The name of the blueprint.
|
|
/// \pre \li Must not be null.
|
|
/// \pre \li Must not be empty.
|
|
/// \return The created blueprint or null if an error occurs.
|
|
/// \remark Must be freed using #ikarus_free.
|
|
IKA_API IkarusBlueprint * ikarus_blueprint_create(struct IkarusProject * project, char const * name);
|
|
|
|
/// \brief Deletes & frees a blueprint.
|
|
/// \param blueprint The blueprint to delete.
|
|
/// \pre \li Must not be null.
|
|
/// \pre \li Must exist.
|
|
/// \remark The blueprint must not be accessed after deletion.
|
|
IKA_API void ikarus_blueprint_delete(IkarusBlueprint * blueprint);
|
|
|
|
/// \brief Gets the number of properties of a blueprint.
|
|
/// \param blueprint The blueprint to get the number of properties of.
|
|
/// \pre \li Must not be null.
|
|
/// \pre \li Must exist.
|
|
/// \return The number of properties or undefined if an error occurs.
|
|
IKA_API size_t ikarus_blueprint_get_property_count(IkarusBlueprint const * blueprint);
|
|
|
|
/// \brief Gets the properties of a blueprint.
|
|
/// \param blueprint The blueprint to get the properties of.
|
|
/// \pre \li Must not be null.
|
|
/// \pre \li Must exist.
|
|
/// \param properties_out The buffer to write the properties to.
|
|
/// \pre \li Must not be null.
|
|
/// \param properties_out_size The size of the buffer.
|
|
IKA_API void ikarus_blueprint_get_properties(
|
|
IkarusBlueprint const * blueprint, struct IkarusProperty ** properties_out, size_t properties_out_size
|
|
);
|
|
|
|
/// \brief Gets the number of entities linked to a blueprint.
|
|
/// \param blueprint The blueprint to get the number of linked entities of.
|
|
/// \pre \li Must not be null.
|
|
/// \pre \li Must exist.
|
|
/// \return The number of linked entities or undefined if an error occurs.
|
|
IKA_API size_t ikarus_blueprint_get_linked_entity_count(IkarusBlueprint const * blueprint);
|
|
|
|
/// \brief Gets the entities linked to a blueprint.
|
|
/// \param blueprint The blueprint to get the linked entities of.
|
|
/// \pre \li Must not be null.
|
|
/// \pre \li Must exist.
|
|
/// \param entities_out The buffer to write the entities to.
|
|
/// \pre \li Must not be null.
|
|
/// \param entities_out_size The size of the buffer.
|
|
IKA_API void ikarus_blueprint_get_linked_entities(
|
|
IkarusBlueprint const * blueprint, struct IkarusEntity ** entities_out, size_t entities_out_size
|
|
);
|
|
|
|
/// \brief Casts a blueprint to an object.
|
|
/// \param blueprint The blueprint to cast.
|
|
/// \pre \li Must not be null.
|
|
/// \pre \li Must exist.
|
|
/// \return The blueprint represented as an object or null if an error occurs.
|
|
/// \remark This operation is guaranteed to be very fast and is intended to be used frequently.
|
|
IKA_API struct IkarusObject * ikarus_blueprint_to_object(IkarusBlueprint * blueprint);
|
|
|
|
/// \see ikarus_blueprint_to_object
|
|
IKA_API struct IkarusObject const * ikarus_blueprint_to_object_const(IkarusBlueprint const * blueprint);
|
|
|
|
IKARUS_END_HEADER
|
|
|
|
// @}
|