Cafu Engine
ViewWindowT Class Referenceabstract

This class represents a (superclass of a) 2D or 3D map view window. More...

#include "ChildFrameViewWin.hpp"

Inheritance diagram for ViewWindowT:

Public Types

enum  ViewTypeT {
  VT_2D_XY, VT_2D_XZ, VT_2D_YZ, VT_3D_WIREFRAME,
  VT_3D_FLAT, VT_3D_EDIT_MATS, VT_3D_FULL_MATS, VT_3D_LM_GRID,
  VT_3D_LM_PREVIEW
}
 

Public Member Functions

void NotifySubjectDies (SubjectT *dyingSubject)
 This method is called whenever a subject is about the be destroyed (and become unavailable). More...
 
virtual wxWindow * GetWindow ()=0
 This function is not const because we can mutate this(!) object via the returned pointer. More...
 
virtual ViewTypeT GetViewType () const =0
 Returns the view type of this view window. More...
 
virtual AxesInfoT GetAxesInfo () const =0
 This method returns the axes info for this window. In the case of a 3D window, it computes the 2D axes info that this view is closest to. More...
 
wxString GetCaption () const
 Returns the caption that the AUI pane for this window should have. More...
 
ChildFrameTGetChildFrame () const
 Returns the child frame that owns this view (that is, our parent). More...
 
MapDocumentTGetMapDoc () const
 The document that is associated with this view window (or more precisely, our child frame). More...
 
- Public Member Functions inherited from ObserverT
virtual void NotifySubjectChanged (SubjectT *Subject, MapDocOtherDetailT OtherDetail)
 Notifies the observer that some other detail than those specifically addressed below has changed. More...
 
virtual void NotifySubjectChanged_Selection (SubjectT *Subject, const ArrayT< MapElementT * > &OldSelection, const ArrayT< MapElementT * > &NewSelection)
 Notifies the observer that the selection in the current subject has been changed. More...
 
virtual void NotifySubjectChanged_Groups (SubjectT *Subject)
 Notifies the observer that the groups in the current subject have been changed (new group added, group deleted, visibility changed, anything). More...
 
virtual void NotifySubjectChanged_Created (SubjectT *Subject, const ArrayT< IntrusivePtrT< cf::GameSys::EntityT > > &Entities)
 Notifies the observer that one or more entities have been created. More...
 
virtual void NotifySubjectChanged_Created (SubjectT *Subject, const ArrayT< MapPrimitiveT * > &Primitives)
 Notifies the observer that one or more map primitives have been created. More...
 
virtual void NotifySubjectChanged_Deleted (SubjectT *Subject, const ArrayT< IntrusivePtrT< cf::GameSys::EntityT > > &Entities)
 Notifies the observer that one or more entities have been deleted. More...
 
virtual void NotifySubjectChanged_Deleted (SubjectT *Subject, const ArrayT< MapPrimitiveT * > &Primitives)
 Notifies the observer that one or more map primitives have been deleted. More...
 
virtual ~ObserverT ()
 The virtual destructor. More...
 
virtual void NotifySubjectChanged_Modified (SubjectT *Subject, const ArrayT< MapElementT * > &MapElements, MapElemModDetailE Detail)
 
virtual void NotifySubjectChanged_Modified (SubjectT *Subject, const ArrayT< MapElementT * > &MapElements, MapElemModDetailE Detail, const ArrayT< BoundingBox3fT > &OldBounds)
 
virtual void Notify_EntChanged (SubjectT *Subject, const ArrayT< IntrusivePtrT< MapEditor::CompMapEntityT > > &Entities, EntityModDetailE Detail)
 
virtual void Notify_VarChanged (SubjectT *Subject, const cf::TypeSys::VarBaseT &Var)
 Notifies the observer that a variable has changed. More...
 
- Public Member Functions inherited from ToolsObserverT
virtual void NotifySubjectChanged (ToolsSubjectT *Subject, ToolT *Tool, ToolsUpdatePriorityT Priority)
 Notifies the observer that the current subject has been changed. More...
 
virtual ~ToolsObserverT ()
 The virtual destructor. More...
 

Protected Member Functions

 ViewWindowT (ChildFrameT *ChildFrame)
 The constructor. It is protected because only child classes should ever be instantiated. More...
 
virtual ~ViewWindowT ()
 The destructor. Virtual such that also the child destructors will be called. More...
 
void UpdateChildFrameMRU ()
 
- Protected Member Functions inherited from ObserverT
 ObserverT ()
 The constructor. It is protected so that only derived classes can create instances of this class. More...
 
- Protected Member Functions inherited from ToolsObserverT
 ToolsObserverT ()
 The constructor. It is protected so that only derived classes can create instances of this class. More...
 

Protected Attributes

ChildFrameTm_ChildFrame
 The child frame that owns us (that is, is our parent). More...
 

Detailed Description

This class represents a (superclass of a) 2D or 3D map view window.

Constructor & Destructor Documentation

ViewWindowT::ViewWindowT ( ChildFrameT ChildFrame)
protected

The constructor. It is protected because only child classes should ever be instantiated.

ViewWindowT::~ViewWindowT ( )
protectedvirtual

The destructor. Virtual such that also the child destructors will be called.

Member Function Documentation

virtual AxesInfoT ViewWindowT::GetAxesInfo ( ) const
pure virtual

This method returns the axes info for this window. In the case of a 3D window, it computes the 2D axes info that this view is closest to.

Implemented in ViewWindow2DT, and ViewWindow3DT.

wxString ViewWindowT::GetCaption ( ) const

Returns the caption that the AUI pane for this window should have.

ChildFrameT * ViewWindowT::GetChildFrame ( ) const

Returns the child frame that owns this view (that is, our parent).

MapDocumentT & ViewWindowT::GetMapDoc ( ) const

The document that is associated with this view window (or more precisely, our child frame).

virtual ViewTypeT ViewWindowT::GetViewType ( ) const
pure virtual

Returns the view type of this view window.

Implemented in ViewWindow2DT, and ViewWindow3DT.

virtual wxWindow* ViewWindowT::GetWindow ( )
pure virtual

This function is not const because we can mutate this(!) object via the returned pointer.

Implemented in ViewWindow2DT, and ViewWindow3DT.

void ViewWindowT::NotifySubjectDies ( SubjectT dyingSubject)
virtual

This method is called whenever a subject is about the be destroyed (and become unavailable).

Parameters
dyingSubjectThe subject that is being destroyed.

Implements ObserverT.

Member Data Documentation

ChildFrameT* ViewWindowT::m_ChildFrame
protected

The child frame that owns us (that is, is our parent).


The documentation for this class was generated from the following files: