Navigation
API > API/Plugins > API/Plugins/AvalancheViewport
Virtual size is one that scales the viewport's ruler's apparent size to the given size. A virtual size of 1920x1080 on a 960x540 viewport will mean pixels are half as big.
| Name | IAvaViewportClient |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheViewport/Public/ViewportClient/IAvaViewportClient.h |
| Include Path | #include "ViewportClient/IAvaViewportClient.h" |
Syntax
class IAvaViewportClient : public IAvaViewportWorldCoordinateConverter
Implements Interfaces
Derived Classes
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FAvaInherits | TAvaInherits< IAvaViewportClient, IAvaViewportWorldCoordinateConverter > | ViewportClient/IAvaViewportClient.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FEditorViewportClient * AsEditorViewportClient() |
ViewportClient/IAvaViewportClient.h | ||
bool EndSnapOperation
(
FAvaSnapOperation* InSnapOperation |
Ends the current snap operation and resets any references. | ViewportClient/IAvaViewportClient.h | |
float GetAverageVirtualViewportScale() |
Returns the average of the above. | ViewportClient/IAvaViewportClient.h | |
UCameraComponent * GetCameraComponentViewTarget() |
Returns the currently active camera component view target (if available) | ViewportClient/IAvaViewportClient.h | |
FVector2f GetConstrainedViewportMousePosition() |
Use the absolute mouse position on the viewport and the zoom settings to return the position of that point if the view were at the default zoom. | ViewportClient/IAvaViewportClient.h | |
FVector2f GetConstrainedZoomedViewportMousePosition () |
Use the absolute mouse position on the viewport and the zoom settings to return the position of that point. | ViewportClient/IAvaViewportClient.h | |
TSharedPtr< FAvaViewportPostProcessManager > GetPostProcessManager() |
ViewportClient/IAvaViewportClient.h | ||
TSharedPtr< FAvaSnapOperation > GetSnapOperation() |
Gets an active snap operation on this viewport. | ViewportClient/IAvaViewportClient.h | |
FVector2f GetUnconstrainedViewportMousePosition () |
Use the absolute mouse position on the viewport and the zoom settings to return the position of that point if the view were at the default zoom. | ViewportClient/IAvaViewportClient.h | |
FVector2f GetUnconstrainedZoomedViewportMousePosition () |
Use the absolute mouse position on the viewport and the zoom settings to return the position of that point. | ViewportClient/IAvaViewportClient.h | |
float GetUnZoomedFOV() |
Gets the FOV of the viewport client when not zoomed in. | ViewportClient/IAvaViewportClient.h | |
float GetViewportDPIScale() |
Gets the DPI scale of the viewport. | ViewportClient/IAvaViewportClient.h | |
FVector2f GetViewportOffset() |
Gets the viewport's offset from the containing widget. | ViewportClient/IAvaViewportClient.h | |
FVector2f GetViewportWidgetSize() |
Gets the total size of the widget that contains the viewport. | ViewportClient/IAvaViewportClient.h | |
UWorld * GetViewportWorld() |
ViewportClient/IAvaViewportClient.h | ||
AActor * GetViewTarget() |
Returns the currently active actor view target (if available) | ViewportClient/IAvaViewportClient.h | |
FVector2f GetVirtualViewportScale() |
Returns (virtual viewport size / viewport size) | ViewportClient/IAvaViewportClient.h | |
FIntPoint GetVirtualViewportSize() |
Gets the full size of the viewport's virtual size when not zoomed in. | ViewportClient/IAvaViewportClient.h | |
| Gets the viewport's non-zoomed virtual visible area. | ViewportClient/IAvaViewportClient.h | ||
FAvaVisibleArea GetVirtualZoomedVisibleArea() |
Gets the viewport's zoomed virtual visible area. Returns the full and calculated-zoom sizes. | ViewportClient/IAvaViewportClient.h | |
| Gets the viewport's non-zoomed visible area. | ViewportClient/IAvaViewportClient.h | ||
TSharedPtr< FAvaCameraZoomController > GetZoomController() |
Returns the object responsible for 2d zooming and panning. | ViewportClient/IAvaViewportClient.h | |
float GetZoomedFOV() |
Gets the FOV of the viewport client when zoomed in, if zoom is supported. | ViewportClient/IAvaViewportClient.h | |
FVector2D GetZoomedFrustumSizeAtDistance
(
double InDistance |
Calculates the size of the frustum plane parallel to the camera's near clip plane at the given distance. | ViewportClient/IAvaViewportClient.h | |
FAvaVisibleArea GetZoomedVisibleArea() |
Gets the viewport's zoomed visible area. Returns the full and calculated-zoom sizes. | ViewportClient/IAvaViewportClient.h | |
bool IsMotionDesignViewport() |
ViewportClient/IAvaViewportClient.h | ||
void OnActorSelectionChanged() |
Called when the actor selection changes. | ViewportClient/IAvaViewportClient.h | |
void OnCameraCut
(
AActor* InCamera, |
Call this when a camera cut occurs. | ViewportClient/IAvaViewportClient.h | |
void SetViewTarget
(
TWeakObjectPtr< AActor > InViewTarget |
Sets the current view target. | ViewportClient/IAvaViewportClient.h | |
TSharedPtr< FAvaSnapOperation > StartSnapOperation() |
Starts an active snap operation on this viewport. Snap operations are only weakly stored. | ViewportClient/IAvaViewportClient.h | |
bool SupportsZoom() |
Returns true if the viewport client supports 2d zoom. | ViewportClient/IAvaViewportClient.h |
Overridden from IAvaTypeCastable
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const void * CastTo_Impl
(
FAvaTypeId InCastToType |
ViewportClient/IAvaViewportClient.h | ||
virtual FAvaTypeId GetTypeId() |
ViewportClient/IAvaViewportClient.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FAvaTypeId GetStaticTypeId() |
ViewportClient/IAvaViewportClient.h |