PRooFPS-dd Dev Doc 1.0
PRooFPS-dd Developer Documentation
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes
proofps_dd::PureObject3dInOutSlider Class Reference

Detailed Description

Definition at line 18 of file PureObject3dInOutSlider.h.

#include <PureObject3dInOutSlider.h>

+ Inheritance diagram for proofps_dd::PureObject3dInOutSlider:

Public Member Functions

CConsole & getConsole () const
 
 PureObject3dInOutSlider ()=default
 
virtual ~PureObject3dInOutSlider () override
 
 PureObject3dInOutSlider (const PureObject3dInOutSlider &)=delete
 
PureObject3dInOutSlider & operator= (const PureObject3dInOutSlider &)=delete
 
 PureObject3dInOutSlider (PureObject3dInOutSlider &&)=delete
 
PureObject3dInOutSlider & operator= (PureObject3dInOutSlider &&)=delete
 
virtual void update (pge_audio::PgeAudio &audio) override
 Steps the slide animation between the Start and Finish positions.
 
virtual void clear () override
 Frees up any loaded resource, like the sound that can be optionally loaded by loadSoundForSlidingIn().
 
const PureObject3D * getPureObject () const
 
const PureObject3D * createPureObject (PureTextureManager &textureManager, PureObject3DManager &objectManager, const char *textureFilename)
 
bool setBlendFuncs (TPURE_BLENDFACTOR src, TPURE_BLENDFACTOR dst)
 
void setScaling (TPureFloat scaling)
 
PureMaterial * getMaterial ()
 
const PureMaterial * getMaterial () const
 
- Public Member Functions inherited from proofps_dd::InOutSlider
CConsole & getConsole () const
 
 InOutSlider ()=default
 
virtual ~InOutSlider ()
 
 InOutSlider (const InOutSlider &)=default
 
InOutSlider & operator= (const InOutSlider &)=default
 
 InOutSlider (InOutSlider &&)=default
 
InOutSlider & operator= (InOutSlider &&)=default
 
TXY & getScreenStartPos ()
 The user shall use this function to set the initial position of the slide-in animation.
 
const TXY & getScreenStartPos () const
 
TXY & getScreenFinishPos ()
 The user shall use this function to set the ending position of the slide-in animation.
 
const TXY & getScreenFinishPos () const
 
const TXY & getScreenCurrentPos () const
 
const AnimState & getState () const
 
const std::chrono::milliseconds::rep & getTimeoutInWaitingState () const
 
void setTimeoutInWaitingState (std::chrono::milliseconds::rep millisecs)
 Sets the duration for waiting in WaitingForTimeout state before transitioning to SlidingOut state.
 
void loadSoundForSlidingIn (pge_audio::PgeAudio &audio, const char *szFilename)
 
void show (pge_audio::PgeAudio &audio)
 Starts or resumes the slide-in animation from the Current position towards the Finish position.
 
void hide (pge_audio::PgeAudio &audio, bool forceStopAudio)
 Starts or resumes the slide-out animation from the Current position towards the Start position.
 

Static Public Member Functions

static const char * getLoggerModuleName ()
 
- Static Public Member Functions inherited from proofps_dd::InOutSlider
static const char * getLoggerModuleName ()
 

Protected Member Functions

virtual void stateEntered (const AnimState &, const AnimState &newState) override
 Invoked by stateEnter() after a successful state transition.
 
- Protected Member Functions inherited from proofps_dd::InOutSlider

Private Attributes

PureObject3D * m_pObj = nullptr
 

Additional Inherited Members

- Public Types inherited from proofps_dd::InOutSlider
enum class  AnimState { Finished , SlidingIn , WaitingForTimeout , SlidingOut }
 Initially, the animation is sitting in Finished state. More...
 

Constructor & Destructor Documentation

◆ PureObject3dInOutSlider() [1/3]

proofps_dd::PureObject3dInOutSlider::PureObject3dInOutSlider ( )
default

◆ ~PureObject3dInOutSlider()

virtual proofps_dd::PureObject3dInOutSlider::~PureObject3dInOutSlider ( )
inlineoverridevirtual

Definition at line 36 of file PureObject3dInOutSlider.h.

◆ PureObject3dInOutSlider() [2/3]

proofps_dd::PureObject3dInOutSlider::PureObject3dInOutSlider ( const PureObject3dInOutSlider & )
delete

◆ PureObject3dInOutSlider() [3/3]

proofps_dd::PureObject3dInOutSlider::PureObject3dInOutSlider ( PureObject3dInOutSlider && )
delete

Member Function Documentation

◆ clear()

virtual void proofps_dd::PureObject3dInOutSlider::clear ( )
inlineoverridevirtual

Frees up any loaded resource, like the sound that can be optionally loaded by loadSoundForSlidingIn().

Derived classes must extend this method by freeing up their loaded resources as well.

Reimplemented from proofps_dd::InOutSlider.

Definition at line 56 of file PureObject3dInOutSlider.h.

◆ createPureObject()

const PureObject3D * proofps_dd::PureObject3dInOutSlider::createPureObject ( PureTextureManager & textureManager,
PureObject3DManager & objectManager,
const char * textureFilename )
inline

Definition at line 71 of file PureObject3dInOutSlider.h.

◆ getConsole()

CConsole & proofps_dd::PureObject3dInOutSlider::getConsole ( ) const
inline

Definition at line 29 of file PureObject3dInOutSlider.h.

◆ getLoggerModuleName()

static const char * proofps_dd::PureObject3dInOutSlider::getLoggerModuleName ( )
inlinestatic

Definition at line 22 of file PureObject3dInOutSlider.h.

◆ getMaterial() [1/2]

PureMaterial * proofps_dd::PureObject3dInOutSlider::getMaterial ( )
inline

Definition at line 127 of file PureObject3dInOutSlider.h.

◆ getMaterial() [2/2]

const PureMaterial * proofps_dd::PureObject3dInOutSlider::getMaterial ( ) const
inline

Definition at line 132 of file PureObject3dInOutSlider.h.

◆ getPureObject()

const PureObject3D * proofps_dd::PureObject3dInOutSlider::getPureObject ( ) const
inline

Definition at line 66 of file PureObject3dInOutSlider.h.

◆ operator=() [1/2]

PureObject3dInOutSlider & proofps_dd::PureObject3dInOutSlider::operator= ( const PureObject3dInOutSlider & )
delete

◆ operator=() [2/2]

PureObject3dInOutSlider & proofps_dd::PureObject3dInOutSlider::operator= ( PureObject3dInOutSlider && )
delete

◆ setBlendFuncs()

bool proofps_dd::PureObject3dInOutSlider::setBlendFuncs ( TPURE_BLENDFACTOR src,
TPURE_BLENDFACTOR dst )
inline

Definition at line 105 of file PureObject3dInOutSlider.h.

◆ setScaling()

void proofps_dd::PureObject3dInOutSlider::setScaling ( TPureFloat scaling)
inline

Definition at line 116 of file PureObject3dInOutSlider.h.

◆ stateEntered()

virtual void proofps_dd::PureObject3dInOutSlider::stateEntered ( const AnimState & ,
const AnimState &  )
inlineoverrideprotectedvirtual

Invoked by stateEnter() after a successful state transition.

Reimplemented from proofps_dd::InOutSlider.

Definition at line 138 of file PureObject3dInOutSlider.h.

◆ update()

virtual void proofps_dd::PureObject3dInOutSlider::update ( pge_audio::PgeAudio & audio)
inlineoverridevirtual

Steps the slide animation between the Start and Finish positions.

Direction and speed depends on the Current position and the SlidingIn state. Derived class may extend this function by using the updated Current position.

Reimplemented from proofps_dd::InOutSlider.

Definition at line 46 of file PureObject3dInOutSlider.h.

Member Data Documentation

◆ m_pObj

PureObject3D* proofps_dd::PureObject3dInOutSlider::m_pObj = nullptr
private

Definition at line 167 of file PureObject3dInOutSlider.h.

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