1. Epic GamesDeveloper
  3. UPoseWatch

UPoseWatch

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Engine/PoseWatch.h
Include #include "Engine/PoseWatch.h"

Syntax

class UPoseWatch : public UObject

Variables

  Type Name Description
Protected variable bool bDeleteOnDeselection  
Protected variable bool bIsExpanded  
Protected variable bool bIsNodeEnabled If true, the node is able to be drawn to the view port.
Protected variable bool bIsVisible If true will draw the pose to the viewport.
Protected variable TArray< TObjectPtr< UPoseWatchElement > > Elements  
Protected variable FText Label  
Public variable TWeakObjectPtr< class UEdGraphNode > Node  
Protected variable TWeakObjectPtr< UPoseWatchFolder > Parent  

Constructors

  Type Name Description
Public function  

UPoseWatch ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function TObjectPtr< TElementType >

AddElement ( const FText InLabel,
const FName IconName
)

 Create a new element of a specified type and add it to this pose watch
Public function TObjectPtr< UPoseWatchElement >

AddElement ( const FText InLabel,
const FName IconName
)

 Create a new element and add it to this pose watch
Public function bool

Contains ( const UPoseWatchElement*const InElement
)

  
Public function bool

Contains ( const TObjectPtr< UPoseWatchElement > InElement
)

 Returns true if this pose watch contains the specified element
Public function TObjectPtr< UPoseWatchElement >

FindElement ( const FText InLabel
)

 Find an element with the supplied label.
Public function TObjectPtr< UPoseWatchElement >

FindOrAddElement ( const FText InLabel,
const FName InIconName
)

 Find and return and existing element with the supplied label or, if none exists, create a new element and add it to this pose watch.
Public function Const UAnimBlueprint * Returns the anim blueprint this pose watch is stored inside
Public function Const FText The default name given to all new pose watches
Public function TArray< TObjectPtr< UPoseWatchElement > > & Returns a reference to the array of elements stored in this
Public function TObjectPtr< TElementType > Returns the first element with the matching type
Public function Const bool Returns true if any child element is enabled
Public function Const bool Returns true if this should display its children in the pose watch manager window
Public function Const bool Returns true if the this pose watch's node is active in its anim graph
Public function Const bool Returns the visibility of this pose watch
Public function Const FText Returns the display label assigned to this pose watch
Public function Const UPoseWatchFolder * Returns the parent folder this pose watch belongs to, if any
Public function Const const FText

GetPath ()

 Returns the slash delimited path of this pose watch
Public function Const bool Returns true if this pose watch should be deleted after the user has deselected its assigned node (Editor preference)
Public function Const bool Returns true if this pose watch is inside some pose watch folder
Public function Const bool

IsIn ( const UPoseWatchFolder* InFolder
)

 Returns true if this pose watch is inside InFolder
Public function Const bool

IsLabelUniqueInParent ( const FText& InLabel,
UPoseWatchFolder* InFolder
)

 Returns true if InLabel is a unique pose watch label among the children of InFolder, excluding this
Public function void

MoveTo ( UPoseWatchFolder* InFolder
)

 Alias of SetParent
Public function void Called when a pose watch is deleted to update it's parent
Public function void

SetIsExpanded ( bool bInIsExpanded
)

 Set whether this should display its children in the pose watch manager window
Public function void

SetIsNodeEnabled ( const bool bInIsEnabled
)

 If set, denotes the pose watch is able to be drawn to the viewport
Public function void

SetIsVisible ( bool bInIsVisible
)

 Sets whether or not to render this pose watch to the viewport
Public function bool

SetLabel ( const FText& InLabel
)

 Attempts to set the label, returns false if unsuccessful (if there's a name clash with another pose watch in the current directory)
Public function bool

SetParent ( UPoseWatchFolder* InParent,
bool bForce
)

 Attempts to set this pose watch's parent, returns false if unsuccessful (if moving causes a name clash) Using bForce may change the pose watch's label to ensure no name clashes
Public function void

SetShouldDeleteOnDeselect ( const bool bInDeleteOnDeselection
)

 Sets whether this pose watch should delete after deselecting it's assigned node (Editor preference)
Public function void Takes GetDefaultLabel() and generates unique labels to avoid name clashes (e.g. PoseWatch1, PoseWatch2, ...)
Public function void Toggle's the pose watch's visibility
Public function void Called when a child element's visibility is changed
Public function bool

ValidateLabelRename ( const FText& InLabel,
FText& OutErrorMessage
)

 Returns true if there would be no name clashes when assigning the label InLabel

Overridden from UObject

  Type Name Description
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Public variable bool bInvertViewportMask_DEPRECATED  
Public variable float BlendScaleThreshold_DEPRECATED  
Protected variable FColor Color_DEPRECATED  
Protected variable FName IconName_DEPRECATED  
Public variable TObjectPtr< UBlendProfile > ViewportMask_DEPRECATED  
Public variable FVector3d ViewportOffset_DEPRECATED  

Deprecated Functions

  Type Name Description
Public function Const FColor Node watches no longer have colors, use the color of its elements instead.
Public function void

SetColor ( const FColor& InColor
)

 Node watches no longer have colors, use the color of its elements instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page