Isaac 2D  1.0
Public Member Functions | Protected Member Functions | List of all members
isaac::IStaticScene Class Referenceabstract
Inheritance diagram for isaac::IStaticScene:
isaac::IScene isaac::CBlankScene Test::SceneOne Test::SceneThree Test::SceneTwo

Public Member Functions

virtual void mp_InitScene (RenderWindow av_xMainWindow, TransientDataCollection &av_xTransientData)=0
 
virtual void mp_InitTriggers (std::shared_ptr< isaac::CTriggerCollection > &)=0
 
virtual void mp_UpdateScene (RenderWindow av_xMainWindow, TransientDataCollection &av_xTransientData, sf::Event av_eventSFMLEvent, bool &av_bReturnedBool_WindowClosed)=0
 
virtual void mp_DrawScene (RenderWindow av_xMainWindow) const =0
 
virtual void mp_Release (TransientDataCollection &av_xTransientData, std::string ac_szTriggerName)=0
 
virtual bool mp_bIsDynamicScene () const
 
- Public Member Functions inherited from isaac::IScene
virtual void mp_InitTriggers (TriggerCollection &av_xTriggerCollection)=0
 
virtual std::string mf_szGetSceneName () const
 
virtual void mp_SetFatherScene (const Scene ac_xFatherScene, const bool &ac_bIsActive=true) const
 
virtual Scene mf_xGetFatherScene () const
 
virtual bool mf_bIsSubScene () const
 
virtual bool mf_bIsFatherSceneActive () const
 

Protected Member Functions

 IStaticScene (std::string ac_szSceneName)
 
- Protected Member Functions inherited from isaac::IScene
 IScene (std::string ac_szSceneName)
 

Additional Inherited Members

- Public Types inherited from isaac::IScene
typedef std::shared_ptr< const isaac::IScene > Scene
 
- Protected Attributes inherited from isaac::IScene
Scene mv_xFatherScene
 
bool mv_bIsFatherSceneActive
 
std::string mc_szSceneName
 

Member Function Documentation

virtual bool isaac::IStaticScene::mp_bIsDynamicScene ( ) const
inlinevirtual

Return value : False

Arguments : none

Implements isaac::IScene.

virtual void isaac::IStaticScene::mp_DrawScene ( RenderWindow  av_xMainWindow) const
pure virtual

Draw what ever you need on the scene. This method is called in a loop while the scene is active

Return value : void

Arguments :

  • Transient Data Collection [std::shared_ptr< const isaac::CTransientDataCollection >]

Implements isaac::IScene.

Implemented in Test::SceneThree, Test::SceneOne, and Test::SceneTwo.

virtual void isaac::IStaticScene::mp_InitScene ( RenderWindow  av_xMainWindow,
TransientDataCollection &  av_xTransientData 
)
pure virtual

In this method you do the initialization of the proces. This method is called before the starting of the scene

Return value : void

Arguments :

  • SFML Render Window [std::shared_ptr< sf::RenderWindow >]
  • Transient Data Collection [std::shared_ptr< const isaac::CTransientDataCollection >]

Implements isaac::IScene.

virtual void isaac::IStaticScene::mp_InitTriggers ( std::shared_ptr< isaac::CTriggerCollection > &  )
pure virtual

Init all the needed defined triggers. This method is called before the starting of the scene, right after the init

Return value : void

Arguments :

  • Trigger Collection [std::shared_ptr<isaac::CTriggerCollection>]

Implemented in isaac::CBlankScene.

virtual void isaac::IStaticScene::mp_Release ( TransientDataCollection &  av_xTransientData,
std::string  ac_szTriggerName 
)
pure virtual

Release(reset or delete) what ever you need. This method is called right before the final release of the scene

Return value : void

Arguments :

  • Transient Data Collection [std::shared_ptr< const isaac::CTransientDataCollection >]
  • Name of the last trigger that was called

Implements isaac::IScene.

virtual void isaac::IStaticScene::mp_UpdateScene ( RenderWindow  av_xMainWindow,
TransientDataCollection &  av_xTransientData,
sf::Event  av_eventSFMLEvent,
bool &  av_bReturnedBool_WindowClosed 
)
pure virtual

Do the scene logic. This method is called in a loop while the scene is active

Return value : void

Arguments :

  • SFML Render Window [std::shared_ptr< sf::RenderWindow >]
  • Transient Data Collection [std::shared_ptr< const isaac::CTransientDataCollection >]
  • SFML Event [sf::Event]
  • reference bool, must be set to true before you decide to close the window. See examples on horiacondrea.com about how to use this parameter in the right way.

Implements isaac::IScene.

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