RE::GFxMovieView Class Reference

#include <GFxMovieView.h>

Inheritance diagram for RE::GFxMovieView:

Public Types
enum class	ScaleModeType { kNoScale , kShowAll , kExactFit , kNoBorder }
enum class	AlignType {   kCenter , kTopCenter , kBottomCenter , kCenterLeft ,   kCenterRight , kTopLeft , kTopRight , kBottomLeft ,   kBottomRight }
enum class	HEResult { kNotHandled = 0 , kHandled = 1 , kNoDefaultAction = 2 , kCompleted = (kHandled | kNoDefaultAction) }
enum class	HitTestType { kBounds = 0 , kShapes = 1 , kButtonEvents = 2 , kShapesNoInvisible = 3 }
Public Types inherited from RE::GFxMovie
enum class	PlayState { kPlaying , kStopped }
enum class	SetVarType { kNormal , kSticky , kPermanent }
enum class	SetArrayType {   kInt , kDouble , kFloat , kString ,   kStringW , kValue }
Public Types inherited from RE::GRefCountBase< GFxMovie, GFxStatMovieViews::kGFxStatMV_Other_Mem >
enum
Public Types inherited from RE::GFxFileConstants
enum class	FileFormatType {   kUnopened , kUnknown , kSWF , kGFX ,   kJPEG = 10 , kPNG = 11 , kGIF = 12 , kTGA = 13 ,   kDDS = 14 , kHDR = 15 , kBMP = 16 , kDIB = 17 ,   kPFM = 18 , kTIFF = 19 , kWAVE = 20 , kNextAvail ,   kOriginal = 65535 }

Public Member Functions
	~GFxMovieView () override
virtual void	SetViewport (const GViewport &a_viewDesc)
virtual void	GetViewport (GViewport *a_viewDesc) const
virtual void	SetViewScaleMode (ScaleModeType a_type)
virtual ScaleModeType	GetViewScaleMode () const
virtual void	SetViewAlignment (AlignType a_type)
virtual AlignType	GetViewAlignment () const
virtual GRectF	GetVisibleFrameRect () const
virtual void	SetPerspective3D (const GMatrix3D &a_projMatIn)
virtual void	SetView3D (const GMatrix3D &a_viewMatIn)
virtual GRectF	GetSafeRect () const
virtual void	SetSafeRect (const GRectF &a_rect)
virtual void	Restart ()
virtual float	Advance (float a_deltaT, std::uint32_t a_frameCatchUpCount=2)
virtual void	Display ()
virtual void	DisplayPrePass ()
virtual void	SetPause (bool a_pause)
virtual bool	IsPaused () const
virtual void	SetBackgroundColor (const GColor a_bgColor)
virtual void	SetBackgroundAlpha (float a_alpha)
virtual float	GetBackgroundAlpha () const
virtual HEResult	HandleEvent (const GFxEvent &a_event)
virtual void	GetMouseState (std::uint32_t a_mouseIndex, float *a_x, float *a_y, std::uint32_t *a_buttons)
virtual void	NotifyMouseState (float a_x, float a_y, std::uint32_t a_buttons, std::uint32_t a_mouseIndex=0)
virtual bool	HitTest (float a_x, float a_y, HitTestType a_testCond=HitTestType::kShapes, std::uint32_t a_controllerIdx=0)
virtual bool	HitTest3D (GPoint3F *a_ptOut, float a_x, float a_y, std::uint32_t a_controllerIdx=0)
virtual void	SetExternalInterfaceRetVal (const GFxValue &a_val)
virtual void *	GetUserData () const
virtual void	SetUserData (void *a_data)
virtual bool	AttachDisplayCallback (const char *a_pathToObject, void(*a_callback)(void *a_user), void *a_user)
virtual bool	IsMovieFocused () const
virtual bool	GetDirtyFlag (bool a_doReset=true)
virtual void	SetMouseCursorCount (std::uint32_t a_count)
virtual std::uint32_t	GetMouseCursorCount () const
virtual void	SetControllerCount (std::uint32_t a_count)
virtual std::uint32_t	GetControllerCount () const
virtual void	GetStats (GStatBag *a_bag, bool a_reset=true)
virtual GMemoryHeap *	GetHeap () const
virtual void	ForceCollectGarbage ()
virtual GPointF	TranslateToScreen (const GPointF &a_p, void *a_userMatrix)
virtual GRectF	TranslateToScreen (const GRectF &a_p, void *a_userMatrix)
virtual bool	TranslateLocalToScreen (const char *a_pathToCharacter, const GPointF &a_pt, GPointF *a_presPt, void *a_userMatrix)
virtual bool	SetControllerFocusGroup (std::uint32_t a_controllerIdx, std::uint32_t a_focusGroupIndex)
virtual std::uint32_t	GetControllerFocusGroup (std::uint32_t a_controllerIdx) const
virtual GFxMovieDef::MemoryContext *	GetMemoryContext () const
virtual void	Release ()
void	SetViewport (std::int32_t a_bufW, std::int32_t a_bufH, std::int32_t a_left, std::int32_t a_top, std::int32_t a_width, std::int32_t a_height, GViewport::Flag a_flags=GViewport::Flag::kNone)
void	InvokeNoReturn (const char *a_methodName, const GFxValue *a_args, std::uint32_t a_numArgs)
Public Member Functions inherited from RE::GFxMovie
virtual GFxMovieDef *	GetMovieDef () const
virtual std::uint32_t	GetCurrentFrame () const
virtual bool	HasLooped () const
virtual void	GotoFrame (std::uint32_t a_frameNumber)
virtual bool	GotoLabeledFrame (const char *a_label, std::int32_t a_offset=0)
virtual void	SetPlayState (PlayState a_state)
virtual PlayState	GetPlayState () const
virtual void	SetVisible (bool a_visible)
virtual bool	GetVisible () const
virtual bool	IsAvailable (const char *a_pathToVar) const
virtual void	CreateString (GFxValue *a_value, const char *a_string)
virtual void	CreateStringW (GFxValue *a_value, const wchar_t *a_string)
virtual void	CreateObject (GFxValue *a_value, const char *a_className=0, const GFxValue *a_args=0, std::uint32_t a_numArgs=0)
virtual void	CreateArray (GFxValue *a_value)
virtual void	CreateFunction (GFxValue *a_value, GFxFunctionHandler *a_fc, void *a_userData=0)
virtual bool	SetVariable (const char *a_pathToVar, const GFxValue &a_value, SetVarType a_setType=SetVarType::kSticky)
virtual bool	GetVariable (GFxValue *a_val, const char *a_pathToVar) const
virtual bool	SetVariableArray (SetArrayType a_type, const char *a_pathToVar, std::uint32_t a_index, const void *a_data, std::uint32_t a_count, SetVarType a_setType=SetVarType::kSticky) const
virtual bool	SetVariableArraySize (const char *a_pathToVar, std::uint32_t a_count, SetVarType a_setType=SetVarType::kSticky)
virtual std::uint32_t	GetVariableArraySize (const char *a_pathToVar)
virtual bool	GetVariableArray (SetArrayType a_type, const char *a_pathToVar, std::uint32_t a_index, void *a_data, std::uint32_t a_count)
virtual bool	InvokeFmt (const char *a_methodName, GFxValue *a_result, const char *a_argFmt,...)
virtual bool	Invoke (const char *a_methodName, GFxValue *a_result, const GFxValue *a_args, std::uint32_t a_numArgs)
virtual bool	InvokeArgs (const char *a_methodName, GFxValue *a_result, const char *a_argFmt, std::va_list a_args)
std::uint32_t	GetFrameCount () const
float	GetFrameRate () const
bool	SetVariable (const char *a_pathToVar, const char *a_value, SetVarType a_setType=SetVarType::kSticky)
bool	SetVariable (const char *a_pathToVar, const wchar_t *a_value, SetVarType a_setType=SetVarType::kSticky)
bool	SetVariableDouble (const char *a_pathToVar, double a_value, SetVarType a_setType=SetVarType::kSticky)
double	GetVariableDouble (const char *a_pathToVar) const
bool	SetVariableArray (const char *a_pathToVar, std::uint32_t a_index, const GFxValue *a_data, std::uint32_t a_count, SetVarType a_setType=SetVarType::kSticky)
bool	GetVariableArray (const char *a_pathToVar, std::uint32_t a_index, GFxValue *a_data, std::uint32_t a_count)
Public Member Functions inherited from RE::GRefCountBaseStatImpl< GRefCountImpl, STAT >
	GFC_MEMORY_REDEFINE_NEW_IMPL (GRefCountImpl, GFC_REFCOUNTALLOC_CHECK_DELETE, StatType)
Public Member Functions inherited from RE::GRefCountImpl
	~GRefCountImpl () override=default
void	AddRef ()
void	Release ()
Public Member Functions inherited from RE::GFxStateBag
virtual	~GFxStateBag ()
virtual void	SetState (GFxState::StateType a_stateType, GFxState *a_state)
virtual GFxState *	GetStateAddRef (GFxState::StateType a_stateType) const
virtual void	GetStatesAddRef (GFxState **a_stateList, const GFxState::StateType *a_stateTypes, std::uint32_t a_count) const
template<class T >
T *	GetStateAddRef (GFxState::StateType a_state) const
GPtr< GFxState >	GetState (GFxState::StateType a_stateType) const
template<class T >
GPtr< T >	GetState (GFxState::StateType a_stateType) const

Friends
class	GFxCharacter

Additional Inherited Members
Static Public Member Functions inherited from RE::GFxMovie
static float	GetRenderPixelScale ()
Static Public Attributes inherited from RE::GRefCountImpl
static constexpr auto	RTTI = RTTI_GRefCountImpl
Protected Member Functions inherited from RE::GFxStateBag
virtual GFxStateBag *	GetStateBagImpl () const

Member Enumeration Documentation

AlignType

enum class RE::GFxMovieView::AlignType

strong

Enumerator
kCenter
kTopCenter
kBottomCenter
kCenterLeft
kCenterRight
kTopLeft
kTopRight
kBottomLeft
kBottomRight

HEResult

enum class RE::GFxMovieView::HEResult

strong

Enumerator
kNotHandled
kHandled
kNoDefaultAction
kCompleted

HitTestType

enum class RE::GFxMovieView::HitTestType

strong

Enumerator
kBounds
kShapes
kButtonEvents
kShapesNoInvisible

ScaleModeType

enum class RE::GFxMovieView::ScaleModeType

strong

Enumerator
kNoScale
kShowAll
kExactFit
kNoBorder

Constructor & Destructor Documentation

~GFxMovieView()

RE::GFxMovieView::~GFxMovieView ( )

override

Member Function Documentation

Advance()

virtual float RE::GFxMovieView::Advance ( float  a_deltaT, std::uint32_t  a_frameCatchUpCount = 2  )

virtual

AttachDisplayCallback()

virtual bool RE::GFxMovieView::AttachDisplayCallback ( const char *  a_pathToObject, void(*)(void *a_user)  a_callback, void *  a_user  )

virtual

Display()

virtual void RE::GFxMovieView::Display ( )

virtual

DisplayPrePass()

virtual void RE::GFxMovieView::DisplayPrePass ( )

virtual

ForceCollectGarbage()

virtual void RE::GFxMovieView::ForceCollectGarbage ( )

virtual

GetBackgroundAlpha()

virtual float RE::GFxMovieView::GetBackgroundAlpha ( ) const

virtual

GetControllerCount()

virtual std::uint32_t RE::GFxMovieView::GetControllerCount ( ) const

virtual

GetControllerFocusGroup()

virtual std::uint32_t RE::GFxMovieView::GetControllerFocusGroup ( std::uint32_t  a_controllerIdx ) const

virtual

GetDirtyFlag()

virtual bool RE::GFxMovieView::GetDirtyFlag ( bool  a_doReset = true )

virtual

GetHeap()

virtual GMemoryHeap * RE::GFxMovieView::GetHeap ( ) const

virtual

GetMemoryContext()

virtual GFxMovieDef::MemoryContext * RE::GFxMovieView::GetMemoryContext ( ) const

virtual

GetMouseCursorCount()

virtual std::uint32_t RE::GFxMovieView::GetMouseCursorCount ( ) const

virtual

GetMouseState()

virtual void RE::GFxMovieView::GetMouseState ( std::uint32_t  a_mouseIndex, float *  a_x, float *  a_y, std::uint32_t *  a_buttons  )

virtual

GetSafeRect()

virtual GRectF RE::GFxMovieView::GetSafeRect ( ) const

virtual

GetStats()

virtual void RE::GFxMovieView::GetStats ( GStatBag *  a_bag, bool  a_reset = true  )

virtual

GetUserData()

virtual void * RE::GFxMovieView::GetUserData ( ) const

virtual

GetViewAlignment()

virtual AlignType RE::GFxMovieView::GetViewAlignment ( ) const

virtual

GetViewport()

virtual void RE::GFxMovieView::GetViewport ( GViewport *  a_viewDesc ) const

virtual

GetViewScaleMode()

virtual ScaleModeType RE::GFxMovieView::GetViewScaleMode ( ) const

virtual

GetVisibleFrameRect()

virtual GRectF RE::GFxMovieView::GetVisibleFrameRect ( ) const

virtual

HandleEvent()

virtual HEResult RE::GFxMovieView::HandleEvent ( const GFxEvent &  a_event )

virtual

HitTest()

virtual bool RE::GFxMovieView::HitTest ( float  a_x, float  a_y, HitTestType  a_testCond = HitTestType::kShapes, std::uint32_t  a_controllerIdx = 0  )

virtual

HitTest3D()

virtual bool RE::GFxMovieView::HitTest3D ( GPoint3F *  a_ptOut, float  a_x, float  a_y, std::uint32_t  a_controllerIdx = 0  )

virtual

InvokeNoReturn()

void RE::GFxMovieView::InvokeNoReturn	(	const char *	a_methodName,
		const GFxValue *	a_args,
		std::uint32_t	a_numArgs
	)

IsMovieFocused()

virtual bool RE::GFxMovieView::IsMovieFocused ( ) const

virtual

IsPaused()

virtual bool RE::GFxMovieView::IsPaused ( ) const

virtual

NotifyMouseState()

virtual void RE::GFxMovieView::NotifyMouseState ( float  a_x, float  a_y, std::uint32_t  a_buttons, std::uint32_t  a_mouseIndex = 0  )

virtual

Release()

virtual void RE::GFxMovieView::Release ( )

virtual

Restart()

virtual void RE::GFxMovieView::Restart ( )

virtual

SetBackgroundAlpha()

virtual void RE::GFxMovieView::SetBackgroundAlpha ( float  a_alpha )

virtual

SetBackgroundColor()

virtual void RE::GFxMovieView::SetBackgroundColor ( const GColor  a_bgColor )

virtual

SetControllerCount()

virtual void RE::GFxMovieView::SetControllerCount ( std::uint32_t  a_count )

virtual

SetControllerFocusGroup()

virtual bool RE::GFxMovieView::SetControllerFocusGroup ( std::uint32_t  a_controllerIdx, std::uint32_t  a_focusGroupIndex  )

virtual

SetExternalInterfaceRetVal()

virtual void RE::GFxMovieView::SetExternalInterfaceRetVal ( const GFxValue &  a_val )

virtual

SetMouseCursorCount()

virtual void RE::GFxMovieView::SetMouseCursorCount ( std::uint32_t  a_count )

virtual

SetPause()

virtual void RE::GFxMovieView::SetPause ( bool  a_pause )

virtual

SetPerspective3D()

virtual void RE::GFxMovieView::SetPerspective3D ( const GMatrix3D &  a_projMatIn )

virtual

SetSafeRect()

virtual void RE::GFxMovieView::SetSafeRect ( const GRectF &  a_rect )

virtual

SetUserData()

virtual void RE::GFxMovieView::SetUserData ( void *  a_data )

virtual

SetView3D()

virtual void RE::GFxMovieView::SetView3D ( const GMatrix3D &  a_viewMatIn )

virtual

SetViewAlignment()

virtual void RE::GFxMovieView::SetViewAlignment ( AlignType  a_type )

virtual

SetViewport() [1/2]

virtual void RE::GFxMovieView::SetViewport ( const GViewport &  a_viewDesc )

virtual

SetViewport() [2/2]

void RE::GFxMovieView::SetViewport	(	std::int32_t	a_bufW,
		std::int32_t	a_bufH,
		std::int32_t	a_left,
		std::int32_t	a_top,
		std::int32_t	a_width,
		std::int32_t	a_height,
		GViewport::Flag	a_flags = GViewport::Flag::kNone
	)

SetViewScaleMode()

virtual void RE::GFxMovieView::SetViewScaleMode ( ScaleModeType  a_type )

virtual

TranslateLocalToScreen()

virtual bool RE::GFxMovieView::TranslateLocalToScreen ( const char *  a_pathToCharacter, const GPointF &  a_pt, GPointF *  a_presPt, void *  a_userMatrix  )

virtual

TranslateToScreen() [1/2]

virtual GPointF RE::GFxMovieView::TranslateToScreen ( const GPointF &  a_p, void *  a_userMatrix  )

virtual

TranslateToScreen() [2/2]

virtual GRectF RE::GFxMovieView::TranslateToScreen ( const GRectF &  a_p, void *  a_userMatrix  )

virtual

Friends And Related Function Documentation

GFxCharacter

friend class GFxCharacter

friend

---

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

• CommonLibSSE/include/RE/G/GFxMovieView.h