#pragma region CPL License
/*
Nuclex Native Framework
Copyright (C) 2002-2013 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#pragma endregion // CPL License

#ifndef NUCLEX_SCENE_GRAPH_DESCRIPTION_H
#define NUCLEX_SCENE_GRAPH_DESCRIPTION_H

#include "Nuclex/Scene/Config.h"

#include <string>

namespace Nuclex { namespace Scene { namespace Graph {

  // ------------------------------------------------------------------------------------------- //

  /// <summary>Supporting information that can be attached to entities</summary>
  class Description {

    /// <summary>Stores the name of the entity</summary>
    /// <remarks>
    ///   This is a freely definable name that will be used when selecting the entity
    ///   in the editor and can also be employed for searches.
    /// </remarks>
    public: std::string Name;

    /// <summary>Which category this entity belongs to</summary>
    /// <remarks>
    ///   Categories are mainly used for selectively showing or hiding certain object
    ///   groups in the editor. They have no relevance to collision detection groups,
    ///   lighting or anything else.
    /// </remarks>
    public: std::size_t Category;

  };

  // ------------------------------------------------------------------------------------------- //

}}} // namespace Nuclex::Scene::Graph

#endif // NUCLEX_SCENE_GRAPH_DESCRIPTION_H