Navigation
API > API/Plugins > API/Plugins/AvalancheViewport > API/Plugins/AvalancheViewport/ViewportClient
Inheritance Hierarchy
- IAvaTypeCastable
- IAvaViewportWorldCoordinateConverter
- IAvaViewportClient
- FAvaViewportClientUtilityProvider
References
| Module | AvalancheViewport |
| Header | /Engine/Plugins/Experimental/Avalanche/Source/AvalancheViewport/Public/ViewportClient/IAvaViewportClient.h |
| Include | #include "ViewportClient/IAvaViewportClient.h" |
Syntax
class IAvaViewportClient : public IAvaViewportWorldCoordinateConverter
Remarks
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.
Functions
| Type | Name | Description | |
|---|---|---|---|
| const FEditorViewportClient * | |||
| bool | EndSnapOperation
(
FAvaSnapOperation* InSnapOperation |
Ends the current snap operation and resets any references. | |
| float | Returns the average of the above. | ||
| UCameraComponent * | Returns the currently active camera component view target (if available) | ||
| FVector2f | 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. | ||
| FVector2f | Use the absolute mouse position on the viewport and the zoom settings to return the position of that point. | ||
| TSharedPtr< FAvaViewportPostProcessManager > | |||
| TSharedPtr< FAvaSnapOperation > | Gets an active snap operation on this viewport. | ||
| FVector2f | 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. | ||
| FVector2f | Use the absolute mouse position on the viewport and the zoom settings to return the position of that point. | ||
| float | Gets the FOV of the viewport client when not zoomed in. | ||
| IAvaViewportDataProvider * | Uses the data proxy to fetch the data provider, if available. | ||
| TSharedPtr< IAvaViewportDataProxy > | Provides access to any viewport-specific data that is available through a third party. | ||
| float | Gets the DPI scale of the viewport. | ||
| FVector2f | Gets the viewport's offset from the containing widget. | ||
| FVector2f | Gets the total size of the widget that contains the viewport. | ||
| UWorld * | |||
| AActor * | Returns the currently active actor view target (if available) | ||
| FVector2f | Returns (virtual viewport size / viewport size) | ||
| FIntPoint | Gets the full size of the viewport's virtual size when not zoomed in. | ||
| FAvaVisibleArea | Gets the viewport's non-zoomed virtual visible area. | ||
| FAvaVisibleArea | Gets the viewport's zoomed virtual visible area. Returns the full and calculated-zoom sizes. | ||
| FAvaVisibleArea | Gets the viewport's non-zoomed visible area. | ||
| TSharedPtr< FAvaCameraZoomController > | Returns the object responsible for 2d zooming and panning. | ||
| float | GetZoomedFOV () |
Gets the FOV of the viewport client when zoomed in, if zoom is supported. | |
| FVector2D | GetZoomedFrustumSizeAtDistance
(
double InDistance |
Calculates the size of the frustum plane parallel to the camera's near clip plane at the given distance. | |
| FAvaVisibleArea | Gets the viewport's zoomed visible area. Returns the full and calculated-zoom sizes. | ||
| void | Called when the actor selection changes. | ||
| void | OnCameraCut
(
AActor* InCamera, |
Call this when a camera cut occurs. | |
| void | SetViewportDataProxy
(
const TSharedPtr< IAvaViewportDataProxy >& InDataProxy |
Sets the third party viewport data provider. | |
| void | SetViewTarget
(
TWeakObjectPtr< AActor > InViewTarget |
Sets the current view target. | |
| TSharedPtr< FAvaSnapOperation > | Starts an active snap operation on this viewport. Snap operations are only weakly stored. | ||
| bool | SupportsZoom () |
Returns true if the viewport client supports 2d zoom. | |