basic/universe/Entity.h

Go to the documentation of this file.

//## begin module%37195CDA01B8.cm preserve=no
//        %X% %Q% %Z% %W%
//## end module%37195CDA01B8.cm

//## begin module%37195CDA01B8.cp preserve=no
//## end module%37195CDA01B8.cp

//## Module: Entity%37195CDA01B8; Pseudo Package specification
//## Source file: C:\project\mpk\code\Universe\Entity.h

#ifndef Entity_h
#define Entity_h 1

//## begin module%37195CDA01B8.additionalIncludes preserve=no
//## end module%37195CDA01B8.additionalIncludes

//## begin module%37195CDA01B8.includes preserve=yes
#include "additional/streams/ifstreamwithcomments.h"
//## end module%37195CDA01B8.includes

// FrameManager
#include "Kinematics\FrameManager.h"

class Matrix4x4;

//## begin module%37195CDA01B8.additionalDeclarations preserve=yes
//## end module%37195CDA01B8.additionalDeclarations


//## begin Entity%37195CDA01B8.preface preserve=yes
//## end Entity%37195CDA01B8.preface

//## Class: Entity%37195CDA01B8; Abstract
//      this is the base class for every type of c++ object that
//      can be added to the universe
//## Category: Universe%36FB145C0082
//## Persistence: Transient
//## Cardinality/Multiplicity: n

//## Uses: <unnamed>%3731E04D001E;Matrix4x4 { -> F}
//## Uses: <unnamed>%37FCF3160113;FrameManager { -> F}

class Entity 
{
  //## begin Entity%37195CDA01B8.initialDeclarations preserve=yes
  //## end Entity%37195CDA01B8.initialDeclarations

  public:
    //## Constructors (specified)
      //## Operation: Entity%925324836
      Entity (FrameManager* frameManager);

      //## Operation: Entity%925324843
      Entity (const Entity& right);

    //## Destructor (generated)
      virtual ~Entity();


    //## Other Operations (specified)
      //## Operation: Clone%924739812
      //        this operation allocates memory for a copy of this
      //        object, and returns a pointer to this new instantiation.
      virtual Entity* Clone () const = 0;

      //## Operation: IsInterfering%925235846
      virtual bool IsInterfering (const Entity* entity) const = 0;

      //## Operation: SetBaseFrame%925235861
      virtual void SetBaseFrame (const unsigned int baseFrame);

      //## Operation: SetFrameManager%925503316
      virtual void SetFrameManager (FrameManager* frameManager);

      //## Operation: GetTransform%926014529
      Matrix4x4 GetTransform () const;

      //## Operation: CanCheckInterference%926300301
      virtual bool CanCheckInterference (const Entity* entity) const = 0;

      //## Operation: BaseFrame%926807003
      unsigned int BaseFrame () const;

      //## Operation: SetName%961125353
      void SetName (const char* name);

      //## Operation: GetName%961125354
      const char* GetName () const;

    // Additional Public Declarations
      //## begin Entity%37195CDA01B8.public preserve=yes
          virtual bool DeserializeEntity( IfstreamWithComments& is ) ;
      //## end Entity%37195CDA01B8.public
  protected:
    // Data Members for Class Attributes

      //## Attribute: baseFrame%371E7E9202F8
      //        this is the frame in which the entity is defined
      //## begin Entity::baseFrame%371E7E9202F8.attr preserve=no  protected: unsigned int {UA} 
      unsigned int baseFrame;
      //## end Entity::baseFrame%371E7E9202F8.attr

      //## Attribute: name%39499B9C0014
      //## begin Entity::name%39499B9C0014.attr preserve=no  protected: char* {UA} NULL
      char* name;
      //## end Entity::name%39499B9C0014.attr

    // Data Members for Associations

      //## Association: geometry::<unnamed>%37263D5600F0
      //## Role: Entity::frameManager%37263D560349
      //## begin Entity::frameManager%37263D560349.role preserve=no  protected: FrameManager { -> 1RHAN}
      FrameManager* frameManager;
      //## end Entity::frameManager%37263D560349.role

    // Additional Protected Declarations
      //## begin Entity%37195CDA01B8.protected preserve=yes
      //## end Entity%37195CDA01B8.protected

  private:
    // Additional Private Declarations
      //## begin Entity%37195CDA01B8.private preserve=yes
      //## end Entity%37195CDA01B8.private

  private: //## implementation
    // Additional Implementation Declarations
      //## begin Entity%37195CDA01B8.implementation preserve=yes
      //## end Entity%37195CDA01B8.implementation

};

//## begin Entity%37195CDA01B8.postscript preserve=yes
//## end Entity%37195CDA01B8.postscript

// Class Entity 

//## begin module%37195CDA01B8.epilog preserve=yes
//## end module%37195CDA01B8.epilog


#endif

---