ABookCaptureActor Class Reference

Public Member Functions
Functions
bool	CanAnimateToPrevPage () const
void	AnimateOpenBook ()
	triggers the paging animation
void	AnimatePageTo (bool _NextPage)
	triggers the paging animation
void	AnimateToNextPage ()
void	AnimateToPreviousPage ()
void	BP_AnimateCloseBook ()
	triggers the paging animation
void	BP_AnimateOpenBook ()
	triggers the paging animation
void	TestNextPage ()
	Prototype test TODO: #jfm: move that to UHUDAnimatedBookUIController? TODO: #jfm: add support for "previous page" animation.
void	TestPreviousPage ()
void	CallRebuildWidget (UUserWidget _PageWidget)
bool	CanAnimateToNextPage () const
void	AnimateCloseBook ()
	triggers the paging animation
UUserWidget	CreateWidget (TSubclassOf< UUserWidget > _WidgetClass)
	helper function for creating widgets
void	EnsureWidgetSet (EBookCapturePage _Page, UUserWidget _Widget, bool _RequireInit)
	will assign the widget to the page and ensure the render target is up to date
EBookCaptureAnimState	GetAnimState () const
	Returns the current animation state.
void	OnBookWidgetClosed ()
void	OnBookWidgetConstructed ()
void	SetInitialPages (UUserWidget _WidgetCover)
	setter for the widget assiciated with a page
void	SetPageWidgets (EBookCapturePage _Page, UUserWidget _PageWidget)
void	SetTintColor (FLinearColor _Color)
	sets the tint color for the book

Static Public Member Functions
Static Functions
static ABookCaptureActor	Spawn (FVector Location=FVector ::ZeroVector, FRotator Rotation=FRotator ::ZeroRotator, FName Name=NAME_None, ULevel Level=nullptr)
static UClass	StaticClass ()

Public Attributes
BookCaptureActor
TMap< int, FPageContent >	m_OrderedPages
int	m_CurrentPageFlip
int	m_NumPages
int	m_CurrentLeftPage
int	m_CurrentRightPage
UDocument	m_CurrentDocument
UUserWidget	m_BookCoverWidget
UUserWidget	m_LeftPageWidget
UUserWidget	m_RightPageWidget
UUserWidget	m_BlankPageWidget
TArray< TObjectPtr< UUserWidget > >	m_PageWidgets
UAnimSequence	m_Animation_CloseBook
UMaterialInterface	m_BookMaterialTemplate
	which material to use
UTexture	m_BaseTextureOverride
	which property defines the base texture for the book
int	m_MaxNumPageFlips
int	m_RenderTargetSize_PageX
	resolution of our render targets
int	m_RenderTargetSize_PageY
USkeletalMeshComponent	m_BookMeshComponent
UAnimSequence	m_Animation_OpenBook
	# put into enum?
FName	m_TintColorParam
	which property to update for the tint color
UAnimSequence	m_Animation_PrevPage
UAnimSequence	m_Animation_NextPage
FName	m_BaseTextureName
	which property defines the base texture for the book
TMap< EBookCapturePage, FName >	m_PageMaterialParamNames
UTextureRenderTarget2D	m_FinalRenderTarget
Variables
FOnBookInitialized	m_OnBookInitialized
const EBookCaptureAnimState	AnimState
	Returns the current animation state.
FOnPageFlipped	m_OnPageFlipped

Member Function Documentation

AnimateCloseBook()

void AnimateCloseBook

(

)

triggers the paging animation

AnimateOpenBook()

void AnimateOpenBook

(

)

triggers the paging animation

AnimatePageTo()

void AnimatePageTo

(

bool

_NextPage

)

triggers the paging animation

AnimateToNextPage()

void AnimateToNextPage

(

)

AnimateToPreviousPage()

void AnimateToPreviousPage

(

)

BP_AnimateCloseBook()

void BP_AnimateCloseBook

(

)

triggers the paging animation

BP_AnimateOpenBook()

void BP_AnimateOpenBook

(

)

triggers the paging animation

CallRebuildWidget()

void CallRebuildWidget

(

UUserWidget

_PageWidget

)

CanAnimateToNextPage()

bool CanAnimateToNextPage

(

)

const

CanAnimateToPrevPage()

bool CanAnimateToPrevPage

(

)

const

CreateWidget()

UUserWidget CreateWidget

(

TSubclassOf< UUserWidget >

_WidgetClass

)

helper function for creating widgets

EnsureWidgetSet()

void EnsureWidgetSet	(	EBookCapturePage	_Page,
		UUserWidget	_Widget,
		bool	_RequireInit )

will assign the widget to the page and ensure the render target is up to date

GetAnimState()

EBookCaptureAnimState GetAnimState

(

)

const

Returns the current animation state.

OnBookWidgetClosed()

void OnBookWidgetClosed

(

)

OnBookWidgetConstructed()

void OnBookWidgetConstructed

(

)

SetInitialPages()

void SetInitialPages

(

UUserWidget

_WidgetCover

)

setter for the widget assiciated with a page

SetPageWidgets()

void SetPageWidgets	(	EBookCapturePage	_Page,
		UUserWidget	_PageWidget )

SetTintColor()

void SetTintColor

(

FLinearColor

_Color

)

sets the tint color for the book

Spawn()

ABookCaptureActor Spawn ( FVector Location = FVector :: ZeroVector, FRotator Rotation = FRotator :: ZeroRotator, FName Name = NAME_None, ULevel Level = nullptr )

static

StaticClass()

UClass StaticClass ( )

static

TestNextPage()

void TestNextPage

(

)

Prototype test TODO: #jfm: move that to UHUDAnimatedBookUIController? TODO: #jfm: add support for "previous page" animation.

TestPreviousPage()

void TestPreviousPage

(

)

Member Data Documentation

AnimState

const EBookCaptureAnimState AnimState

Returns the current animation state.

m_Animation_CloseBook

UAnimSequence m_Animation_CloseBook

m_Animation_NextPage

UAnimSequence m_Animation_NextPage

m_Animation_OpenBook

UAnimSequence m_Animation_OpenBook

# put into enum?

m_Animation_PrevPage

UAnimSequence m_Animation_PrevPage

m_BaseTextureName

FName m_BaseTextureName

which property defines the base texture for the book

m_BaseTextureOverride

UTexture m_BaseTextureOverride

which property defines the base texture for the book

m_BlankPageWidget

UUserWidget m_BlankPageWidget

m_BookCoverWidget

UUserWidget m_BookCoverWidget

m_BookMaterialTemplate

UMaterialInterface m_BookMaterialTemplate

which material to use

m_BookMeshComponent

USkeletalMeshComponent m_BookMeshComponent

m_CurrentDocument

UDocument m_CurrentDocument

m_CurrentLeftPage

int m_CurrentLeftPage

m_CurrentPageFlip

int m_CurrentPageFlip

m_CurrentRightPage

int m_CurrentRightPage

m_FinalRenderTarget

UTextureRenderTarget2D m_FinalRenderTarget

m_LeftPageWidget

UUserWidget m_LeftPageWidget

m_MaxNumPageFlips

int m_MaxNumPageFlips

m_NumPages

int m_NumPages

m_OnBookInitialized

FOnBookInitialized m_OnBookInitialized

m_OnPageFlipped

FOnPageFlipped m_OnPageFlipped

m_OrderedPages

TMap<int,FPageContent> m_OrderedPages

m_PageMaterialParamNames

TMap<EBookCapturePage,FName> m_PageMaterialParamNames

m_PageWidgets

TArray<TObjectPtr<UUserWidget> > m_PageWidgets

m_RenderTargetSize_PageX

int m_RenderTargetSize_PageX

resolution of our render targets

m_RenderTargetSize_PageY

int m_RenderTargetSize_PageY

m_RightPageWidget

UUserWidget m_RightPageWidget

m_TintColorParam

FName m_TintColorParam

which property to update for the tint color