2.9.16.0
Coherent GT for UE4
UCoherentUIGTBaseComponent Class Reference
+ Inheritance diagram for UCoherentUIGTBaseComponent:

Public Types

typedef TSharedPtr< TCoherentUIGTViewListener< UCoherentUIGTBaseComponent > > ListenerPtr
 
typedef TSharedPtr< FCoherentUIGTRenderWrapperRenderWrapperPtr
 
typedef TArray< TWeakObjectPtr< UCoherentUIGTBaseComponent > > WeakCoherentUIGTComponentsArray
 

Public Member Functions

virtual void Resize (int32 width, int32 height)
 
bool IsReadyToCreateView () const
 
bool IsReadyForBindings () const
 
bool HasRequestedView () const
 
bool IsTransparent () const
 
void ShowPaintRects (bool show)
 
void Redraw () const
 
void Load (const FString &path)
 
void Reload ()
 
bool IsDocumentReady () const
 
void DebugSaveNextFrame ()
 
void BeginDebugFrameSave ()
 
void EndDebugFrameSave ()
 
void SetClickThroughAlphaThreshold (float threshold)
 
float GetClickThroughAlphaThreshold () const
 
void EnableDelayedUpdate (bool bEnabled)
 
UCoherentUIGTJSEventCreateJSEvent ()
 
void TriggerJSEvent (const FString &name, UCoherentUIGTJSEvent *eventData) const
 
void CreateDataModelFromObject (const FString &Name, UObject *Model)
 
void CreateDataModelFromStruct (const FString &Name, const TFieldPath< FStructProperty > Arg)
 
void UpdateWholeDataModelFromStruct (const TFieldPath< FStructProperty > Arg) const
 
void UpdateWholeDataModelFromObject (UObject *Model) const
 
void SynchronizeModels () const
 
void SetSoundAttenuation (const FAttenuationSettingsClass &settings)
 
 DECLARE_DELEGATE_RetVal (TUniquePtr< FCohComponentViewState >, FOnViewStateAdoption)
 
 DECLARE_DELEGATE_OneParam (FOnViewStatePostAdoption, const TUniquePtr< FCohComponentViewState > &)
 
 DECLARE_DELEGATE_OneParam (FOnViewStatePutForAdoption, TUniquePtr< FCohComponentViewState > &)
 
Coherent::UIGT::View * GetView () const
 
virtual void InitializeComponent () override
 
virtual void BeginDestroy () override
 
virtual bool IsReadyForFinishDestroy () override
 
virtual void FinishDestroy () override
 
virtual void TickComponent (float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override
 
void IssueMouseOnUIQuery (float normX, float normY)
 
bool EnsureMeshData ()
 
const FCaretRectGetCaretRect () const
 
void SetCaretRect (int x, int y, unsigned width, unsigned height)
 
Coherent::UIGT::ViewRenderer * GetViewRenderer () const
 
 DECLARE_FUNCTION (execCreateDataModelFromStruct)
 
 DECLARE_FUNCTION (execUpdateWholeDataModelFromStruct)
 

Static Public Member Functions

static void CreateSystemIfNecessary (UWorld *World)
 
static class ACoherentUIGTSystemGetSystemActor (UWorld *World)
 
static WeakCoherentUIGTComponentsArray::TIterator GetUCoherentUIGTBaseComponentIterator (UWorld *world)
 

Public Attributes

FUIGTReadyForBindingsSignature ReadyForBindings
 
FUIGTBindingsReleasedSignature BindingsReleased
 
FUIGTFinishLoadSignature FinishLoad
 
FUIGTFailLoadSignature FailLoad
 
FUIGTStartLoadingSignature StartLoading
 
FUIGTNavigateToSignature NavigateTo
 
FUIGTOnJavaScriptEvent JavaScriptEvent
 
FUIGTScriptingReady UIGTScriptingReady
 
FUIGTOnLiveViewSizeRequest LiveViewSizeRequested
 
FUIGTOnPerformanceAuditSignature OnPerformanceAudit
 
UTextureRenderTarget2D * Texture
 
TEnumAsByte< enum TextureFilter > Filter
 
bool bReceiveInput
 
bool bReceiveInputWhenTransparent
 
bool AllowPerformanceWarnings
 
float ExecuteJSTimersThresholdMs
 
float UpdateStylesAndLayoutThresholdMs
 
float RecordRenderingCommandsThresholdMs
 
float PaintWarningThresholdMs
 
int32 LayersCountThreshold
 
int32 LayerWidthThreshold
 
int32 LayerHeightThreshold
 
bool bEnableAdditionalDefaultStyles
 
bool bDelayedUpdate
 
FOnViewStateAdoption OnViewStateAdoption
 
FOnViewStatePostAdoption OnViewStatePostAdoption
 
FOnViewStatePutForAdoption OnViewStatePutForAdoption
 
EMouseCursor::Type CurrentMouseCursor
 
TArray< FCoherentUIGTMeshDataMeshData
 
bool bWasMouseOnUILastFrame
 

Protected Member Functions

void CreateView (const Coherent::UIGT::ViewInfo &info, const FString &url, bool PaintToBackBuffer=false)
 

Protected Attributes

ListenerPtr Listener
 
RenderWrapperPtr RenderWrapper
 

Friends

class TCoherentUIGTViewListener< UCoherentUIGTBaseComponent >
 

Member Function Documentation

◆ BeginDebugFrameSave()

void UCoherentUIGTBaseComponent::BeginDebugFrameSave ( )

Starts saving render frames to disk

◆ CreateDataModelFromObject()

void UCoherentUIGTBaseComponent::CreateDataModelFromObject ( const FString &  Name,
UObject *  Model 
)

Creates a global variable (data model) in JavaScript from an UObject

◆ CreateDataModelFromStruct()

void UCoherentUIGTBaseComponent::CreateDataModelFromStruct ( const FString &  Name,
const TFieldPath< FStructProperty >  Arg 
)

Creates a global variable (data model) in JavaScript from a UStruct

◆ CreateJSEvent()

UCoherentUIGTJSEvent* UCoherentUIGTBaseComponent::CreateJSEvent ( )

Creates an event that will be executed in JavaScript

◆ DebugSaveNextFrame()

void UCoherentUIGTBaseComponent::DebugSaveNextFrame ( )

Saves next render frame to disk

◆ EnableDelayedUpdate()

void UCoherentUIGTBaseComponent::EnableDelayedUpdate ( bool  bEnabled)

Delays UI updates until after cameras are updated. Read the section in the FAQ page of the documentation before using

◆ EndDebugFrameSave()

void UCoherentUIGTBaseComponent::EndDebugFrameSave ( )

Stops saving render frames to disk

◆ GetClickThroughAlphaThreshold()

float UCoherentUIGTBaseComponent::GetClickThroughAlphaThreshold ( ) const

Gets the alpha threshold for click-through queries

◆ HasRequestedView()

bool UCoherentUIGTBaseComponent::HasRequestedView ( ) const

Tells if a View has been scheduled for creation

◆ IsDocumentReady()

bool UCoherentUIGTBaseComponent::IsDocumentReady ( ) const

Tells if the Document object is ready in JS

◆ IsReadyForBindings()

bool UCoherentUIGTBaseComponent::IsReadyForBindings ( ) const

Tells if the View is ready to be created

◆ IsReadyToCreateView()

bool UCoherentUIGTBaseComponent::IsReadyToCreateView ( ) const

Tells if the View is ready to be created

◆ IsTransparent()

bool UCoherentUIGTBaseComponent::IsTransparent ( ) const

Gets if the View is transparent

◆ Load()

void UCoherentUIGTBaseComponent::Load ( const FString &  path)

Requests a new URL to be loaded in the View

◆ Redraw()

void UCoherentUIGTBaseComponent::Redraw ( ) const

Requests a View to completely re-draw itself

◆ Reload()

void UCoherentUIGTBaseComponent::Reload ( )

Requests the View to reload the current URL

◆ Resize()

virtual void UCoherentUIGTBaseComponent::Resize ( int32  width,
int32  height 
)
virtual

Resizes the View

Reimplemented in UCoherentUIGTComponent, and UCoherentUIGTHUD.

◆ SetClickThroughAlphaThreshold()

void UCoherentUIGTBaseComponent::SetClickThroughAlphaThreshold ( float  threshold)

Click-through queries check the alpha under the mouse. This value defines the threshold when a pixel is categorized on the UI or on the Game

◆ SetSoundAttenuation()

void UCoherentUIGTBaseComponent::SetSoundAttenuation ( const FAttenuationSettingsClass &  settings)

Sets the AttenuationSettings for the Sound Components Note: Sound is 2D by default. It can be changed to 3D if appropriate AttenuationSettings is set. for more details look at Unreal's documentation for AttenuationSettings

◆ ShowPaintRects()

void UCoherentUIGTBaseComponent::ShowPaintRects ( bool  show)

Tells the view to show/hide debug paint rectangles

◆ SynchronizeModels()

void UCoherentUIGTBaseComponent::SynchronizeModels ( ) const

Synchronize all models marked for update.

◆ TriggerJSEvent()

void UCoherentUIGTBaseComponent::TriggerJSEvent ( const FString &  name,
UCoherentUIGTJSEvent eventData 
) const

Triggers an event in JavaScript

◆ UpdateWholeDataModelFromObject()

void UCoherentUIGTBaseComponent::UpdateWholeDataModelFromObject ( UObject *  Model) const

Marks an Object model for update. The UI using this data model will be updated during the next call to SynchronizeModels. For optimum performance, call SynchronizeModels as rarely as possible.

◆ UpdateWholeDataModelFromStruct()

void UCoherentUIGTBaseComponent::UpdateWholeDataModelFromStruct ( const TFieldPath< FStructProperty >  Arg) const

Marks a Struct model for update. The UI using this data model will be updated during the next call to SynchronizeModels. For optimum performance, call SynchronizeModels as rarely as possible.

Member Data Documentation

◆ bDelayedUpdate

bool UCoherentUIGTBaseComponent::bDelayedUpdate

Changes this component's tick group to TG_PostUpdateWork and sends bindings before drawing. For more information refer to the FAQ section of the documentation.

◆ bEnableAdditionalDefaultStyles

bool UCoherentUIGTBaseComponent::bEnableAdditionalDefaultStyles

If true, in the page will be added additional default styles for scrollbars. Those styles will allow pages outside the user control to look correctly (like websites), but incur a performance penalty.

◆ BindingsReleased

FUIGTBindingsReleasedSignature UCoherentUIGTBaseComponent::BindingsReleased

When fired, the View has released its bindings.

◆ bReceiveInput

bool UCoherentUIGTBaseComponent::bReceiveInput

Indicates whether input is forwarded to this view

◆ bReceiveInputWhenTransparent

bool UCoherentUIGTBaseComponent::bReceiveInputWhenTransparent

When enabled, the View will always receive input, even in transparent areas that otherwise are click-through.

◆ FailLoad

FUIGTFailLoadSignature UCoherentUIGTBaseComponent::FailLoad

Called when the requested page has failed its load for some reason

◆ FinishLoad

FUIGTFinishLoadSignature UCoherentUIGTBaseComponent::FinishLoad

Called when the requested page has been loaded completely

◆ JavaScriptEvent

FUIGTOnJavaScriptEvent UCoherentUIGTBaseComponent::JavaScriptEvent

Called an event for this View is triggered in JavaScript

◆ LiveViewSizeRequested

FUIGTOnLiveViewSizeRequest UCoherentUIGTBaseComponent::LiveViewSizeRequested

Called when a Live View needs its size, only if there are no Live View components on this Actor.

◆ NavigateTo

FUIGTNavigateToSignature UCoherentUIGTBaseComponent::NavigateTo

Called when View has navigated to a new page

◆ OnPerformanceAudit

FUIGTOnPerformanceAuditSignature UCoherentUIGTBaseComponent::OnPerformanceAudit

Called when a performance audit has completed

◆ OnViewStateAdoption

FOnViewStateAdoption UCoherentUIGTBaseComponent::OnViewStateAdoption

This delegate can be used to set the ViewState, adopted from a previous run via OnViewStatePutForAdoption. It will be executed at the beginning of the BaseComponents Initialization. If a valid unique ptr to the ViewState is given here, it will be reused instead of creating a new one.

◆ OnViewStatePostAdoption

FOnViewStatePostAdoption UCoherentUIGTBaseComponent::OnViewStatePostAdoption

This delegate can be used to handle any required setup or cleanup code after the ViewState was adopted by the BaseComponents via OnViewStateAdoption. If you are using Coherent Binding, this is a good location to add Binding related re-initialization code.

◆ OnViewStatePutForAdoption

FOnViewStatePutForAdoption UCoherentUIGTBaseComponent::OnViewStatePutForAdoption

This delegate can be used to get the ViewState from the BaseComponent. It will be executed at the beginning of the BaseComponents BeginDestruction. If the unique ptr to the ViewState is adopted in to the client code and invalidated in the process, the ViewState will be kept and can be later reused via OnViewStateAdoption.

◆ ReadyForBindings

FUIGTReadyForBindingsSignature UCoherentUIGTBaseComponent::ReadyForBindings

When fired, the View is ready for binding events. Any event bound prior to this will be ignored

◆ StartLoading

FUIGTStartLoadingSignature UCoherentUIGTBaseComponent::StartLoading

Called when View has started loading a new page

◆ Texture

UTextureRenderTarget2D* UCoherentUIGTBaseComponent::Texture

Gives access to the UI Texture

◆ UIGTScriptingReady

FUIGTScriptingReady UCoherentUIGTBaseComponent::UIGTScriptingReady

Called when the View is ready to accept events