1. Epic GamesDeveloper
  3. ITypedElementWorldInterface

ITypedElementWorldInterface

API > API/Runtime > API/Runtime/Engine

   
Name ITypedElementWorldInterface
Type class
Header File /Engine/Source/Runtime/Engine/Public/Elements/Interfaces/TypedElementWorldInterface.h
Include Path #include "Elements/Interfaces/TypedElementWorldInterface.h"

Syntax

class ITypedElementWorldInterface

Derived Classes

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool AddIgnoredElementToCollisionQueryParams ( const FTypedElementHandle& InElementHandle,
FCollisionQueryParams& InOutParams,
bool bAlsoIgnoreSubElements
)

 Attempt to modify FCollisionQueryParams so that the given element (and optionally any attached sub-elements, if the element is part of a hierarchy) is ignored in the query. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool CanCopyElement ( const FTypedElementHandle& InElementHandle
)

   Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool CanDeleteElement ( const FScriptTypedElementHandle& InElementHandle
)

 Can the given element be deleted? Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual bool CanDeleteElement ( const FTypedElementHandle& InElementHandle
)

 Can the given element be deleted? Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool CanDuplicateElement ( const FTypedElementHandle& InElementHandle
)

 Can the given element be duplicated? Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool CanDuplicateElement ( const FScriptTypedElementHandle& InElementHandle
)

 Can the given element be duplicated? Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual bool CanEditElement ( const FScriptTypedElementHandle& InElementHandle
)

 Can this element actually be edited in the world? Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual bool CanEditElement ( const FTypedElementHandle& InElementHandle
)

 Can this element actually be edited in the world? Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool CanMoveElement ( const FScriptTypedElementHandle& InElementHandle,
const ETypedElementWorldType InWorldType
)

 Can the given element be moved within the world? Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual bool CanMoveElement ( const FTypedElementHandle& InElementHandle,
const ETypedElementWorldType InWorldType
)

 Can the given element be moved within the world? Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool CanPromoteElement ( const FScriptTypedElementHandle& InElementHandle
)

 Can the element be promoted Generally available when the element is a lighter representation of another element. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual bool CanPromoteElement ( const FTypedElementHandle& InElementHandle
)

 Can the element be promoted Generally available when the element is lighter representation of another element. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool CanScaleElement ( const FScriptTypedElementHandle& InElementHandle
)

 Can the given element be scaled? Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual bool CanScaleElement ( const FTypedElementHandle& InElementHandle
)

 Can the given element be scaled? Elements/Interfaces/TypedElementWorldInterface.h  

virtual void CopyElement ( const FTypedElementHandle& InElementHandle,
FOutputDevice& Out
)

 Copy the given element into a object to export Elements/Interfaces/TypedElementWorldInterface.h  

virtual void CopyElements ( TArrayView< const FTypedElementHandle > InElementHandles,
FOutputDevice& Out
)

 Copy the given set of elements into a object to export. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool DeleteElement ( const FScriptTypedElementHandle& InElementHandle,
UWorld* InWorld,
UTypedElementSelectionSet* InSelectionSet,
const FTypedElementDeletionOptions& InDeletionOptions
)

 Delete the given element. Default version calls DeleteElements with a single element. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual bool DeleteElement ( const FTypedElementHandle& InElementHandle,
UWorld* InWorld,
UTypedElementSelectionSet* InSelectionSet,
const FTypedElementDeletionOptions& InDeletionOptions
)

 Delete the given element. Default version calls DeleteElements with a single element. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool DeleteElements ( TArrayView< const FTypedElementHandle > InElementHandles,
UWorld* InWorld,
UTypedElementSelectionSet* InSelectionSet,
const FTypedElementDeletionOptions& InDeletionOptions
)

 Delete the given set of elements. Elements/Interfaces/TypedElementWorldInterface.h  

virtual FScriptTypedElementHandle DuplicateElement ( const FScriptTypedElementHandle& InElementHandle,
UWorld* InWorld,
const FVector& InLocationOffset
)

 Duplicate the given element. Default version calls DuplicateElements with a single element. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual FTypedElementHandle DuplicateElement ( const FTypedElementHandle& InElementHandle,
UWorld* InWorld,
const FVector& InLocationOffset
)

 Duplicate the given element. Default version calls DuplicateElements with a single element. Elements/Interfaces/TypedElementWorldInterface.h  

virtual void DuplicateElements ( TArrayView< const FTypedElementHandle > InElementHandles,
UWorld* InWorld,
const FVector& InLocationOffset,
TArray< FTypedElementHandle >& OutNewElements
)

 Duplicate the given set of elements. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool FindSuitableTransformAlongPath ( const FTypedElementHandle& InElementHandle,
const FVector& InPathStart,
const FVector& InPathEnd,
const FCollisionShape& InTestShape,
TArrayView< const FTypedElementHandle > InElementsToIgnore,
FTransform& OutSuitableTransform
)

 Attempt to find a suitable (non-intersecting) transform for the given element along the given path. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool FindSuitableTransformAtPoint ( const FTypedElementHandle& InElementHandle,
const FTransform& InPotentialTransform,
FTransform& OutSuitableTransform
)

 Attempt to find a suitable (non-intersecting) transform for the given element at the given point. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool GetBounds ( const FTypedElementHandle& InElementHandle,
FBoxSphereBounds& OutBounds
)

 Get the bounds of this element, if any. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool GetBounds ( const FScriptTypedElementHandle& InElementHandle,
FBoxSphereBounds& OutBounds
)

 Get the bounds of this element, if any. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual ULevel * GetOwnerLevel ( const FScriptTypedElementHandle& InElementHandle
)

 Get the owner level associated with this element, if any. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual ULevel * GetOwnerLevel ( const FTypedElementHandle& InElementHandle
)

 Get the owner level associated with this element, if any. Elements/Interfaces/TypedElementWorldInterface.h  

virtual UWorld * GetOwnerWorld ( const FScriptTypedElementHandle& InElementHandle
)

 Get the owner world associated with this element, if any. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual UWorld * GetOwnerWorld ( const FTypedElementHandle& InElementHandle
)

 Get the owner world associated with this element, if any. Elements/Interfaces/TypedElementWorldInterface.h  

virtual TSharedPtr< FWorldElementPasteImporter > GetPasteImporter()

   Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool GetPivotOffset ( const FScriptTypedElementHandle& InElementHandle,
FVector& OutPivotOffset
)

 Get the local space offset of this element that should be added to its pivot location, if any. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual bool GetPivotOffset ( const FTypedElementHandle& InElementHandle,
FVector& OutPivotOffset
)

 Get the local space offset of this element that should be added to its pivot location, if any. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool GetRelativeTransform ( const FTypedElementHandle& InElementHandle,
FTransform& OutTransform
)

 Get the transform of this element relative to its parent, if any. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool GetRelativeTransform ( const FScriptTypedElementHandle& InElementHandle,
FTransform& OutTransform
)

 Get the transform of this element relative to its parent, if any. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual TArray< FTypedElementHandle > GetSelectionElementsFromSelectionFunction ( const FTypedElementHandle& Handle,
const FWorldSelectionElementArgs& SelectionArgs,
const TFunction< bool(const FTypedElementHandle&, const FWorldSelectionElementArgs&)>& SelectionF...
)

   Elements/Interfaces/TypedElementWorldInterface.h  

TArray< FTypedElementHandle > GetSelectionElementsInBox ( const FTypedElementHandle& Handle,
const FBox& InBox,
const FWorldSelectionElementArgs& SelectionArgs
)

 Get the selectable elements from this element that are inside the the convex volume Elements/Interfaces/TypedElementWorldInterface.h  

TArray< FTypedElementHandle > GetSelectionElementsInConvexVolume ( const FTypedElementHandle& Handle,
const FConvexVolume& InVolume,
const FWorldSelectionElementArgs& SelectionArgs
)

 Get the selectable elements from this element that are inside the the convex volume Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool GetWorldTransform ( const FScriptTypedElementHandle& InElementHandle,
FTransform& OutTransform
)

 Get the transform of this element within its owner world, if any. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual bool GetWorldTransform ( const FTypedElementHandle& InElementHandle,
FTransform& OutTransform
)

 Get the transform of this element within its owner world, if any. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool IsElementInBox ( const FTypedElementHandle& Handle,
const FBox& InBox,
bool bMustEncompassEntireElement
)

 Return true if the element is in the Box Note: This should only be use for editor tools since it doesn't use the physics system and the performance would probably be to slow for a runtime application. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool IsElementInConvexVolume ( const FTypedElementHandle& Handle,
const FConvexVolume& InVolume,
bool bMustEncompassEntireElement
)

 Return true if the element is in the volume Note: This should only be use for editor tools since it doesn't use the physics system and the performance would probably be to slow for a runtime application. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool IsTemplateElement ( const FTypedElementHandle& InElementHandle
)

 Is this element considered a template within its world (eg, a CDO or archetype). Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool IsTemplateElement ( const FScriptTypedElementHandle& InElementHandle
)

 Script Api Is this element considered a template within its world (eg, a CDO or archetype). Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual void NotifyMovementEnded ( const FTypedElementHandle& InElementHandle
)

 Notify that this element is done being moved. Elements/Interfaces/TypedElementWorldInterface.h  

virtual void NotifyMovementEnded ( const FScriptTypedElementHandle& InElementHandle
)

 Notify that this element is done being moved. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual void NotifyMovementOngoing ( const FTypedElementHandle& InElementHandle
)

 Notify that this element is currently being moved. Elements/Interfaces/TypedElementWorldInterface.h  

virtual void NotifyMovementOngoing ( const FScriptTypedElementHandle& InElementHandle
)

 Notify that this element is currently being moved. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual void NotifyMovementStarted ( const FScriptTypedElementHandle& InElementHandle
)

 Notify that this element is about to be moved. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual void NotifyMovementStarted ( const FTypedElementHandle& InElementHandle
)

 Notify that this element is about to be moved. Elements/Interfaces/TypedElementWorldInterface.h  

virtual FTypedElementHandle PromoteElement ( const FTypedElementHandle& InElementHandle,
UWorld* OverrideWorld
)

 Promote a element when possible Generally available when the element is lighter representation of another element. Elements/Interfaces/TypedElementWorldInterface.h  

virtual FScriptTypedElementHandle PromoteElement ( const FScriptTypedElementHandle& InElementHandle,
UWorld* OverrideWorld
)

 Promote an element when possible Generally available when the element is a lighter representation of another element. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual bool SetPivotOffset ( const FTypedElementHandle& InElementHandle,
const FVector& InPivotOffset
)

 Attempt to set the local space offset of this element that should be added to its pivot location. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool SetPivotOffset ( const FScriptTypedElementHandle& InElementHandle,
const FVector& InPivotOffset
)

 Attempt to set the local space offset of this element that should be added to its pivot location. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual bool SetRelativeTransform ( const FTypedElementHandle& InElementHandle,
const FTransform& InTransform
)

 Attempt to set the transform of this element relative to its parent. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool SetRelativeTransform ( const FScriptTypedElementHandle& InElementHandle,
const FTransform& InTransform
)

 Attempt to set the transform of this element relative to its parent. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

virtual bool SetWorldTransform ( const FTypedElementHandle& InElementHandle,
const FTransform& InTransform
)

 Attempt to set the transform of this element within its owner world. Elements/Interfaces/TypedElementWorldInterface.h  

virtual bool SetWorldTransform ( const FScriptTypedElementHandle& InElementHandle,
const FTransform& InTransform
)

 Attempt to set the transform of this element within its owner world. Elements/Interfaces/TypedElementWorldInterface.h
  • BlueprintCallable
  • Category="TypedElementInterfaces|World"

Protected

Name Remarks Include Path Unreal Specifiers

virtual UTypedElementRegistry & GetRegistry()

 Return the registry associated with this interface implementation Elements/Interfaces/TypedElementWorldInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page