nel/tools/3d/pipeline_max/builtin/reference_target.h

   1 /**
   2  * \file reference_target.h
   3  * \brief CReferenceTarget
   4  * \date 2012-08-22 08:53GMT
   5  * \author Jan Boon (Kaetemi)
   6  * CReferenceTarget
   7  */
   8
   9 /*
  10  * Copyright (C) 2012  by authors
  11  *
  12  * This file is part of RYZOM CORE PIPELINE.
  13  * RYZOM CORE PIPELINE is free software: you can redistribute it
  14  * and/or modify it under the terms of the GNU Affero General Public
  15  * License as published by the Free Software Foundation, either
  16  * version 3 of the License, or (at your option) any later version.
  17  *
  18  * RYZOM CORE PIPELINE is distributed in the hope that it will be
  19  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  20  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Affero General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU Affero General Public
  24  * License along with RYZOM CORE PIPELINE.  If not, see
  25  * <http://www.gnu.org/licenses/>.
  26  */
  27
  28 #ifndef PIPELINE_REFERENCE_TARGET_H
  29 #define PIPELINE_REFERENCE_TARGET_H
  30 #include <nel/misc/types_nl.h>
  31
  32 // STL includes
  33
  34 // NeL includes
  35
  36 // Project includes
  37 #include "reference_maker.h"
  38
  39 namespace PIPELINE {
  40 namespace MAX {
  41 namespace BUILTIN {
  42
  43 /**
  44  * \brief CReferenceTarget
  45  * \date 2012-08-22 08:53GMT
  46  * \author Jan Boon (Kaetemi)
  47  * Dummy class, supposed to send or receive events or something.
  48  * Nice for copy pasting the basic class layout.
  49  */
  50 class CReferenceTarget : public CReferenceMaker
  51 {
  52 public:
  53         CReferenceTarget(CScene *scene);
  54         virtual ~CReferenceTarget();
  55
  56         // class desc
  57         static const ucstring DisplayName;
  58         static const char *InternalName;
  59         static const char *InternalNameUnknown;
  60         static const NLMISC::CClassId ClassId;
  61         static const TSClassId SuperClassId;
  62
  63         // inherited
  64         virtual void parse(uint16 version, uint filter = 0);
  65         virtual void clean();
  66         virtual void build(uint16 version, uint filter = 0);
  67         virtual void disown();
  68         virtual void init();
  69         virtual bool inherits(const NLMISC::CClassId classId) const;
  70         virtual const ISceneClassDesc *classDesc() const;
  71         virtual void toStringLocal(std::ostream &ostream, const std::string &pad = "", uint filter = 0) const;
  72
  73 protected:
  74         // inherited
  75         virtual IStorageObject *createChunkById(uint16 id, bool container);
  76
  77 }; /* class CReferenceTarget */
  78
  79 typedef CSceneClassDesc<CReferenceTarget> CReferenceTargetClassDesc;
  80 extern const CReferenceTargetClassDesc ReferenceTargetClassDesc;
  81 typedef CSuperClassDesc<CReferenceTarget> CReferenceTargetSuperClassDesc;
  82 extern const CReferenceTargetSuperClassDesc ReferenceTargetSuperClassDesc;
  83
  84 } /* namespace BUILTIN */
  85 } /* namespace MAX */
  86 } /* namespace PIPELINE */
  87
  88 #endif /* #ifndef PIPELINE_REFERENCE_TARGET_H */
  89
  90 /* end of file */