3DDummy.h

Go to the documentation of this file.

//! @file 3DDummy.h
//! @brief C3DDummy class for handling 3D dummy object
//!
//////////////////////////////////////////////////////////////////////
 
#if !defined(AFX_3DDUMMY_H__5C85DAE7_BE95_4F8B_B661_B0CF9BE55255__INCLUDED_)
#define AFX_3DDUMMY_H__5C85DAE7_BE95_4F8B_B661_B0CF9BE55255__INCLUDED_
 
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
 
#include "3DBaseObject.h"
 
BEGIN_MOOTOOLS_NAMESPACE
 
//! @class C3DDummy
//! @brief  A dummy is a void object that does not contains geometry.
//! @details A dummy object can encapsulate any kind of specific data using the CCustomData object, retrieved using C3DBaseObject::GetData.
class DLL_3DFUNCTION C3DDummy : public C3DBaseObject 
{
    DECLARE_SERIAL_XOBJECT(C3DDummy);
 
protected:
    // the internal CCustomData ID value that defines the dummy type
    typedef enum  SpecificData XEnumType(unsigned int)
    {
        DUMMY_DATA_TYPE = MAKE_CUSTOM_ID('D', 'Y', 'T', 'Y'), // Dummy type.
    } SpecificData;
 
public:
    //! @enum DummyType
    //! the kind of dummy
    typedef enum  DummyType XEnumType(unsigned int)
    {
        DUMMY_VOID = MAKE_CUSTOM_ID('V', 'O', 'I', 'D'), //!< This is a dummy dummy object. Default one if none specified
        DUMMY_HELIODON = MAKE_CUSTOM_ID('H', 'E', 'L', 'I'), //!< The dummy matches an heliodon
        DUMMY_VEGETATION = MAKE_CUSTOM_ID('V', 'E', 'G', 'E'),  //!< The dummy matches some vegetation
        DUMMY_CHARACTER = MAKE_CUSTOM_ID('C', 'H', 'A', 'R'),  //!< The dummy matches a character
        DUMMY_VEHICULE = MAKE_CUSTOM_ID('V', 'E', 'H', 'I'),  //!< The dummy matches a car
    } DummyType;
 
public:
    C3DDummy();
    virtual ~C3DDummy();
 
    DummyType GetType() const;  //!< Get the #DummyType
    void SetType(DummyType type); //!< Get the #DummyType
 
    virtual unsigned int GetChecksum(unsigned int checksumFlags = CHECKSUM_ALL) const; // Return a value that only take care of the type. See GetChecksum(unsigned int ignoreCustomDataID, ...) to get advanced checksum computation base on the 
};
 
END_MOOTOOLS_NAMESPACE
 
#endif // !defined(AFX_3DDUMMY_H__5C85DAE7_BE95_4F8B_B661_B0CF9BE55255__INCLUDED_)