1. Epic GamesDeveloper
  3. FCustomizableObjectEditorViewportClient

FCustomizableObjectEditorViewportClient

Viewport Client for the preview viewport

API > API/Plugins > API/Plugins/CustomizableObjectEditor > API/Plugins/CustomizableObjectEditor/MuCOE

Inheritance Hierarchy

References

   
Module CustomizableObjectEditor
Header /Engine/Plugins/Experimental/Mutable/Source/CustomizableObjectEditor/Public/MuCOE/CustomizableObjectEditorViewportClient.h
Include #include "MuCOE/CustomizableObjectEditorViewportClient.h"

Syntax

class FCustomizableObjectEditorViewportClient :  
    public FEditorViewportClient,  
    public TSharedFromThis< FCustomizableObjectEditorViewportClient >

Remarks

Viewport Client for the preview viewport

Variables

  Type Name Description
Public variable UPersonaOptions * ConfigOption Persona config options

Constructors

  Type Name Description
Public function  

FCustomizableObjectEditorViewportClient ( TWeakPtr< class ICustomizableObjectInstanceEditor > InCustomizableObjectEditor,
FPreviewScene* InPreviewScene
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Add Light Component to the scene
Public function bool Returns true if any projector node is currently selected (in the case of the Customizable Object Editor)
Public function void Callback for baking the current instance. If nullptr is passed, the instance in the editor will be taken.
Public function void Callback for baking the current instance. If nullptr is passed, the instance in the editor will be taken.
Public function Const void

BuildMeanTimesBoxSize ( const float MinValue,
const float MaxValue,
const float MeanValue,
const float MaxWidth,
const float Data,
float& BoxSize,
FLinearColor& BoxColor
)

 Returns in BoxSize and BoxColor the data for drawing the visual clue of the performance test for state enter and parameter update
Public function void

BuildMeanTimesBoxSizes ( float MaxWidth,
TArray< float >& ArrayData,
TArray< float >& ArrayBoxSize,
TArray< FLinearColor >& ArrayBoxColor
)

 Returns in ArrayBoxSize and ArrayBoxColor the data for drawing the visual clue of the performance for the state enter and update test
Public function void Updates the origin data of this gizmo proxy with the information present in GizmoRTSProxy::Value
Public function void

DrawCylinderArc ( FPrimitiveDrawInterface* PDI,
const FMatrix& CylToWorld,
const FVector& Base,
const FVector& XAxis,
const FVector& YAxis,
const FVector& ZAxis,
float Radius,
float HalfHeight,
uint32 Sides,
const FMaterialRenderProxy* MaterialRenderProxy,
uint8 DepthPriority,
FColor Color,
float MaxAngle
)

 Debug draw a partial cylinder, given by MaxAngle in [0, 2PI]
Public function void Draws Mesh Bones in foreground (From: FAnimationViewportClient)
Public function void

DrawShadowedString ( FCanvas* Canvas,
float StartX,
float StartY,
const FLinearColor& Color,
float TextScale,
FString String
)

 Helper method to draw shadowed string on viewport
Public function void

DrawUVs ( FViewport* InViewport,
FCanvas* InCanvas,
int32 InTextYPos,
const FString& MaterialName
)

 Draws the UV overlay for the current LOD.
Public function FSphere Returns the desired target of the camera
Public function bool Getter of viewport's environment visibility
Public function Const float Returns the floor height offset
Public function bool Getter of viewport's floor visibility
Public function bool Getter for LevelViewportClient::GizmoProxy::AssignedDataIsFromNode
Public function bool Getter for LevelViewportClient::GizmoProxy::HasAssignedData
Public function bool Getter of GizmoRTSProxy::IsProjectorParameterSelected
Public function FString Getter for LevelViewportClient::GizmoProxy::ProjectorParameterName
Public function FString Getter for LevelViewportClient::GizmoProxy::ProjectorParameterNameWithIndex
Public function const GizmoRTSProxy &  
Public function bool Getter of viewport's grid visibility
Public function bool Getter for bManipulating
Public function bool Getter for StateChangeShowDataFlag
Public function TArray< FName > Get associated texture parameter names for the material given as parameter
Public function bool

GetUniqueResourceName ( UObject* InResource,
FString& InOutResourceName,
TArray< UObject* >& InCachedObjects,
TArray< FString >& InCachedObjectNames
)

 Returns false if the resource has already been duplicated, otherwise, returns true and an unique ResourceName.
Public function bool Getter for WidgetVisibility
Public function bool  
Public function Const bool Returns camera mode
Public function Const bool Callback for checking the UV overlay show flag.
Public function Const bool Callback for checking the bounds show flag.
Public function Const bool Callback for checking the collision geometry show flag.
Public function Const bool Callback for checking the grid show flag.
Public function Const bool Callback for checking the pivot show flag.
Public function Const bool Callback for checking the sky show flag.
Public function Const bool Returns true if bones are vibile in viewport
Public function bool

ManageBakingAction ( const FString& Path,
const FString& Name
)

 If baking files that already exist, ask the user for permission to overwirte them.
Public function void

OnAssetViewerSettingsChanged ( const FName& InPropertyName
)

 Delegate for preview profile is changed (used for updating show flags)
Public function void To notify of changes in any parameter projector node property in case is the one being used, currently just the projector type parameter is taken into account
Public function void To notify of changes in any parameter projector node property in case is the one being used, currently just the projector type parameter is taken into account
Public function void Remove Light component from the scene. use destroy component instead?
Public function void Set again the animation saved in AnimationBeingPlayed (if any)
Public function void Point the camera to the Skeletal Mesh Components.
Public function void  
Public function void

SetAdvancedShowFlagsForScene ( const bool bAdvancedShowFlags
)

 Sets up the ShowFlag according to the current preview scene profile
Public function void

SetAnimation ( UAnimationAsset* Animation,
EAnimationMode::Type AnimationType
)

  
Public function void

SetAssetRegistryLoaded ( bool Value
)

 Setter of AssetRegistryLoaded
Public function void

SetCameraMode ( bool Value
)

 Sets camera mode
Public function void

SetClipMeshVisibility ( bool bVisible,
UStaticMesh* ClipMesh,
UCustomizableObjectNodeMeshClipWithMesh* ClipMeshNode
)

  
Public function void

SetClipMorphPlaneVisibility ( bool bVisible,
const FVector& Origin,
const FVector& Normal,
float MorphLength,
const FBoxSphereBounds& Bounds,
float InRadius1,
float InRadius2,
float InRotationAngle
)

  
Public function void  
Public function void

SetCustomizableObject ( UCustomizableObject* CustomizableObjectParameter
)

 Setter of CustomizableObject
Public function void Callback for toggling the UV overlay show flag.
Public function void

SetDrawUVOverlayMaterial ( const FString& MaterialName,
FString UVChannel
)

 Set the material index whose UVs will be drawn.
Public function void

SetEnvironmentMeshVisibility ( uint32 Value
)

 Setter of viewport's environment visibility
Public function void

SetFloorOffset ( float NewValue
)

 Sets the floor height offset, saves it to config and invalidates the viewport so it shows up immediately
Public function void

SetFloorVisibility ( bool Value
)

 Setter of viewport's floor visibility
Public function void Setter for LevelViewportClient::GizmoProxy::CallUpdateSkeletalMesh
Public function void

SetPreviewComponent ( UStaticMeshComponent* InPreviewStaticMeshComponent
)

  
Public function void

SetPreviewComponents ( const TArray< UDebugSkelMeshComponent* >& InPreviewSkeletalMeshComponents
)

  
Public function void  
Public function void

SetProjectorType ( bool bVisible,
FString ProjectorParameterName,
FString ProjectorParameterNameWithIndex,
int32 ProjectorRangeIndex,
const FCustomizableObjectProjector& Data,
int32 ProjectorParameterIndex
)

  
Public function void  
Public function void

SetProjectorVisibility ( bool bVisible,
FString ProjectorParameterName,
FString ProjectorParameterNameWithIndex,
int32 ProjectorRangeIndex,
const FCustomizableObjectProjector& Data,
int32 ProjectorParameterIndex
)

  
Public function void  
Public function void Sets an informative message in the viewport warning the user that the CustomizableObject has no reference mesh
Public function void

SetSelectedLight ( ULightComponent* SelectedLight
)

 Select/Unselect lights, selected lights can be edited using gizmos
Public function void Sets the skeletal mesh bones visibility
Public function void Callback for toggling the bounds show flag.
Public function void Callback for toggling the collision geometry show flag.
Public function void Callback for toggling the grid show flag.
Public function void Callback for toggling the pivot show flag.
Public function void Callback for toggling the sky show flag.
Public function void Setter for StateChangeShowDataFlag
Public function void

SetVisibilityForWireframeMode ( bool bIsWireframeMode
)

  
Public function void Show pero LOD geometric information of the instance
Public function void Callback to show / hide instance geometry data.
Public function void  
Public function void  
Public function void Update the current gizmo data to its corresponding data origin

Overridden from FEditorViewportClient

  Type Name Description
Public function Virtual Const bool Whether or not the new widget mode can be set in this viewport
Public function Virtual Const FLinearColor  
Public function Virtual Const FMatrix  
Public function Virtual Const ECoordSystem  
Public function Virtual Const FVector  
Public function Virtual Const UE::Widget::EWidgetMode  
Public function Virtual bool

InputWidgetDelta ( FViewport* InViewport,
EAxisList::Type CurrentAxis,
FVector& Drag,
FRotator& Rot,
FVector& Scale
)

 Called to give the viewport client a chance to handle widgets being moved
Public function Virtual void

SetViewportType ( ELevelViewportType InViewportType
)

 Set the viewport type of the client
Public function Virtual void

SetWidgetCoordSystemSpace ( ECoordSystem NewCoordSystem
)

 Sets the coordinate system space to use
Public function Virtual void

Tick ( float DeltaSeconds
)

 Ticks this viewport client
Public function Virtual void

TrackingStarted ( const FInputEventState& InInputState,
bool bIsDraggingWidget,
bool bNudge
)

 Called when mouse movement tracking begins
Public function Virtual void Called when mouse movement tracking stops

Overridden from FViewportClient

  Type Name Description
Public function Virtual void

Draw ( FViewport* Viewport,
FCanvas* Canvas
)

  
Public function Virtual bool

InputKey ( const FInputKeyEventArgs& EventArgs
)

 Check a key event received by the viewport.

Overridden from FViewElementDrawer

  Type Name Description
Public function Virtual void

Draw ( const FSceneView* View,
FPrimitiveDrawInterface* PDI
)

 FViewElementDrawer interface

Overridden from FGCObject

  Type Name Description
Public function Virtual void FGCObject interface
Public function Virtual Const FString Overload this method to report a name for your referencer

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page