1. Epic GamesDeveloper
  3. IPCGAttributeAccessorKeys

IPCGAttributeAccessorKeys

Base class to identify keys to use with an accessor.

API > API/Plugins > API/Plugins/PCG

Base class to identify keys to use with an accessor.

   
Name IPCGAttributeAccessorKeys
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/Metadata/Accessors/PCGAttributeAccessorKeys.h
Include Path #include "Metadata/Accessors/PCGAttributeAccessorKeys.h"

Syntax

class IPCGAttributeAccessorKeys

Derived Classes

IPCGAttributeAccessorKeys derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

IPCGAttributeAccessorKeys ( bool bInReadOnly
)

   Metadata/Accessors/PCGAttributeAccessorKeys.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IPCGAttributeAccessorKeys()

   Metadata/Accessors/PCGAttributeAccessorKeys.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GetKey ( int32 InStart,
ObjectType const*& OutObject
)

 Same function but const. Metadata/Accessors/PCGAttributeAccessorKeys.h  

bool GetKey ( int32 InStart,
ObjectType*& OutObject
)

 Retrieve in the given argument pointer of the wanted type. Metadata/Accessors/PCGAttributeAccessorKeys.h  

bool GetKey ( ObjectType const*& OutObject
) const

 Same function but const. Metadata/Accessors/PCGAttributeAccessorKeys.h  

bool GetKey ( ObjectType*& OutObject
)

 Retrieve in the given argument pointer of the wanted type at the index 0. Metadata/Accessors/PCGAttributeAccessorKeys.h  

virtual bool GetKeyIndices ( int32 InStart,
int32 InCount,
TArray< int32 >& OutKeyIndices,
bool& bOutContiguous
) const

 Retrieve in the given array indices that can be accessed for Accessor/AccessorKeys that support it It will wrap around if the index/range goes outside the number of keys. Metadata/Accessors/PCGAttributeAccessorKeys.h  

bool GetKeys ( int32 InStart,
TArrayView< ObjectType* > OutKeys
)

 Retrieve in the given view pointers of the wanted type Need to be a supported type, such as FPCGPoint, PCGMetadataEntryKey or void. Metadata/Accessors/PCGAttributeAccessorKeys.h  

bool GetKeys ( int32 InStart,
TArrayView< const ObjectType* > OutKeys
) const

 Same function but const. Metadata/Accessors/PCGAttributeAccessorKeys.h  

int32 GetNum()

 Returns the number of keys. Metadata/Accessors/PCGAttributeAccessorKeys.h  

virtual bool IsClassSupported ( const UStruct* InClass
) const

 Returns true if GetGenericObjectKeys would return this class/struct Metadata/Accessors/PCGAttributeAccessorKeys.h  

bool IsReadOnly()

   Metadata/Accessors/PCGAttributeAccessorKeys.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual bool GetGenericObjectKeys ( int32 InStart,
TArrayView< const void* > OutObjects
) const

   Metadata/Accessors/PCGAttributeAccessorKeys.h  

virtual bool GetGenericObjectKeys ( int32 InStart,
TArrayView< void* > OutObjects
)

   Metadata/Accessors/PCGAttributeAccessorKeys.h  

virtual bool GetMetadataEntryKeys ( int32 InStart,
TArrayView< PCGMetadataEntryKey* > OutEntryKeys
)

   Metadata/Accessors/PCGAttributeAccessorKeys.h  

virtual bool GetMetadataEntryKeys ( int32 InStart,
TArrayView< const PCGMetadataEntryKey* > OutEntryKeys
) const

   Metadata/Accessors/PCGAttributeAccessorKeys.h  

virtual bool GetPointKeys ( int32 InStart,
TArrayView< FPCGPoint* > OutPoints
)

   Metadata/Accessors/PCGAttributeAccessorKeys.h  

virtual bool GetPointKeys ( int32 InStart,
TArrayView< const FPCGPoint* > OutPoints
) const

   Metadata/Accessors/PCGAttributeAccessorKeys.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page