Veda/PackFloatByte_Color.h

Go to the documentation of this file.
00001 /*! \file 
00002     \author victorien ferry & www.m4nkind.com
00003     \brief This file applies the GNU LESSER GENERAL PUBLIC LICENSE Version 2.1 , read file COPYING.
00004 */
00005 #ifndef COM_M4NKIND_PackFloatByte_Color_H
00006 #define COM_M4NKIND_PackFloatByte_Color_H
00007 
00008 #include "PackFloatByte_Limits.h"
00009 
00010 #ifdef _ENGINE_EDITABLE_
00011 // if we are in editable mode:
00012 /*!
00013     \class  PackFloatByte_Color
00014     \ingroup    BaseSerializableClass
00015     \brief  It specify PackFloatByte_Limits to express a R,G,B color.
00016              this specification is adressed with GetClassID() to interfaces.
00017              in non-editable mode, it is PackFloatByte_Limits typedef.
00018 */
00019 class PackFloatByte_Color : public PackFloatByte_Limits
00020 {
00021 /*==================================================================
00022                                 PUBLIC
00023 ==================================================================*/
00024 public:
00025 
00026     /*!
00027         \brief  Constructor. 
00028     */
00029     PackFloatByte_Color(void);
00030 
00031     /*!
00032         \brief  Constructor To initialize PackFloat as a multi dimentional vector. 
00033         \param _DimensionEnum on of the 3 VectorDimension enum.
00034     */
00035     PackFloatByte_Color( VectorDimension _DimensionEnum );
00036 
00037     /*!
00038         \brief  Destructor. 
00039     */
00040     virtual ~PackFloatByte_Color(void);
00041 
00042     /*!
00043         \brief  Each BaseType's inherited classes must explicit an ID for their
00044                 class, or let use one of the super class at least through this virtual method.
00045                 This is needed by GUIs to detect the types of each sub-members, and shape
00046                 an interface for each Object according to their member list.
00047         \return a const character string, that must be unique and unchanged for all serializable base type.
00048     */
00049     virtual const char *GetClassID() const { return "PackFloat::PackFloatByte_Limits::PackFloatByte_Color"; };
00050 
00051 /*==================================================================
00052                                 PROTECTED
00053 ==================================================================*/
00054 protected:
00055 
00056 };
00057 #else
00058 /*!
00059     \class  PackFloatByte_Color
00060 
00061     \brief  It specify PackFloatByte_Limits to express a R,G,B color.
00062              this specification is adressed with GetClassID() to interfaces.
00063              in non-editable mode, it is PackFloatByte_Limits typedef.
00064 */
00065 typedef PackFloatByte_Limits PackFloatByte_Color;
00066 #endif
00067 // end of .h:
00068 #endif

      /\/\        4         N         k         !         N         D
                      _______  _ __ ___  _____            ___ _ _  ____
     ___________  __//___   /________  |/    / ___________\_______/    \
    /   _   _   \/   _     /    _   /      _/_/____/    _       __     /
   /    /   /       /     /    /    \      \/     /    /    \   \     /
  \\___/___/___/    ¯    _____/_____/       ______\___/_____/\________\\
               \________/_ ___ __ l____\      /elD!  
                 http://www.m4nkind.com \____/