FPointsFacade

[FPointsFacade](API\Runtime\Chaos\FPointsFacade)

API > API/Runtime > API/Runtime/Chaos

FPointsFacade

Defines common API for storing points with attributes in a collection. The points/attributes are stored in the Points group.

   
Name FPointsFacade
Type class
Header File /Engine/Source/Runtime/Experimental/Chaos/Public/GeometryCollection/Facades/PointsFacade.h
Include Path #include "GeometryCollection/Facades/PointsFacade.h"

Syntax

class FPointsFacade

Constructors

Name Remarks Include Path Unreal Specifiers
FPointsFacade Constuctor GeometryCollection/Facades/PointsFacade.h  
  GeometryCollection/Facades/PointsFacade.h  
  GeometryCollection/Facades/PointsFacade.h  

Constants

Name Type Remarks Include Path
PointAttribute const FName   GeometryCollection/Facades/PointsFacade.h
PointsGroup const FName   GeometryCollection/Facades/PointsFacade.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ConstCollection const FManagedArrayCollection &   GeometryCollection/Facades/PointsFacade.h  
MutableCollection FManagedArrayCollection *   GeometryCollection/Facades/PointsFacade.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddBoolAttribute ( const FName InAttribute,
const TBitArray<>& InValues
)

   GeometryCollection/Facades/PointsFacade.h  

bool AddBoolAttribute ( const FName InAttribute,
const TArray< bool >& InValues
)

   GeometryCollection/Facades/PointsFacade.h  

bool AddFloatAttribute ( const FName InAttribute,
const TArray< float >& InValues
)

 Add attribute to the points GeometryCollection/Facades/PointsFacade.h  

bool AddIntAttribute ( const FName InAttribute,
const TArray< int32 >& InValues
)

   GeometryCollection/Facades/PointsFacade.h  

void AddPoints ( const TArray< FVector3f >& InPoints
)

 Add points to the collection GeometryCollection/Facades/PointsFacade.h  

void AddPoints ( const FPointsFacade& InPointsFacade
)

   GeometryCollection/Facades/PointsFacade.h  

void AddPoints ( const TArray< FVector >& InPoints
)

   GeometryCollection/Facades/PointsFacade.h  

bool AddVector2Attribute ( const FName InAttribute,
const TArray< FVector2f >& InValues
)

   GeometryCollection/Facades/PointsFacade.h  

bool AddVector3Attribute ( const FName InAttribute,
const TArray< FVector3f >& InValues
)

   GeometryCollection/Facades/PointsFacade.h  

void AppendPoints ( const FPointsFacade& InPointsFacade
)

   GeometryCollection/Facades/PointsFacade.h  

void AppendPoints ( const TArray< FVector >& InPoints
)

   GeometryCollection/Facades/PointsFacade.h  

void AppendPoints ( const TArray< FVector3f >& InPoints
)

   GeometryCollection/Facades/PointsFacade.h  

void DefineSchema()

 Adds neccessary group/Attribute GeometryCollection/Facades/PointsFacade.h  

void DeletePoints ( const TArray< int32 >& InSortedDeletionList
)

 Delete points from the collection GeometryCollection/Facades/PointsFacade.h  

void FilterByFloatAttributeToArray ( const FName InAttribute,
const EFilterByAttributeOperation InOperation,
float InValue,
float InValue2,
TArray< FVector >& OutPoints
) const

   GeometryCollection/Facades/PointsFacade.h  

void FilterByFloatAttributeToCollection ( const FName InAttribute,
const EFilterByAttributeOperation InOperation,
float InValue,
float InValue2,
FManagedArrayCollection& OutCollection
) const

 Filter points by a float attribute value GeometryCollection/Facades/PointsFacade.h  

void FilterByFloatAttributeToSelection ( const FName InAttribute,
const EFilterByAttributeOperation InOperation,
float InValue,
float InValue2,
TArray< int32 >& OutPointSelection
) const

   GeometryCollection/Facades/PointsFacade.h  

bool GeneratePointsInBox ( const FBox& InBox,
float InPointSeparation
)

 Generate points in an AABB GeometryCollection/Facades/PointsFacade.h  

bool GeneratePointsOnPlane ( const FBox& InBox,
const int32 InPlaneOrientation,
float InPointSeparation,
float InOffset
)

 Generate points in an AABB on a plane GeometryCollection/Facades/PointsFacade.h  

EManagedArrayType GetAttributeType ( const FName& InAttribute
) const

 Get attribute type GeometryCollection/Facades/PointsFacade.h  

TArray< FName > GetAttrs()

 Get list of attributes on the points GeometryCollection/Facades/PointsFacade.h  

FString GetAttrsAsString ( bool bAddCommaSeparator
) const

   GeometryCollection/Facades/PointsFacade.h  

const bool GetBoolAttributeValue ( const FName InAttribute,
const int32 ElementIndex
) const

   GeometryCollection/Facades/PointsFacade.h  

const TBitArray & GetBoolAttributeValues ( const FName InAttribute
) const

   GeometryCollection/Facades/PointsFacade.h  

FBox GetBoundingBox()

 Computes the smallest AABB for the points GeometryCollection/Facades/PointsFacade.h  

FSphere GetBoundingSphere()

 Computes the smallest bounding sphere for the points GeometryCollection/Facades/PointsFacade.h  

const FManagedArrayCollection & GetConstCollection()

 Get Access to the ConstCollection. GeometryCollection/Facades/PointsFacade.h  

const float GetFloatAttributeValue ( const FName InAttribute,
const int32 ElementIndex
) const

 Get the element of a specified attribute from the array GeometryCollection/Facades/PointsFacade.h  

const TArray< float > & GetFloatAttributeValues ( const FName InAttribute
) const

 Get the values of a specified attribute as an array GeometryCollection/Facades/PointsFacade.h  

const int32 GetIntAttributeValue ( const FName InAttribute,
const int32 ElementIndex
) const

   GeometryCollection/Facades/PointsFacade.h  

const TArray< int32 > & GetIntAttributeValues ( const FName InAttribute
) const

   GeometryCollection/Facades/PointsFacade.h  

int32 GetNumAttrs()

 Get number of attributes on the points GeometryCollection/Facades/PointsFacade.h  

int32 GetNumPoints()

 Get number of points in the collection GeometryCollection/Facades/PointsFacade.h  

TArray< FVector > GetPointsAsArray()

 Get the points as a TArray (it returns the point positions, all attributes will be lost) GeometryCollection/Facades/PointsFacade.h  

TArray< FVector3f > GetPointsAsFloatArray()

   GeometryCollection/Facades/PointsFacade.h  

const FVector2f GetVector2AttributeValue ( const FName InAttribute,
const int32 ElementIndex
) const

   GeometryCollection/Facades/PointsFacade.h  

const TArray< FVector2f > & GetVector2AttributeValues ( const FName InAttribute
) const

   GeometryCollection/Facades/PointsFacade.h  

const FVector3f GetVector3AttributeValue ( const FName InAttribute,
const int32 ElementIndex
) const

   GeometryCollection/Facades/PointsFacade.h  

const TArray< FVector3f > & GetVector3AttributeValues ( const FName InAttribute
) const

   GeometryCollection/Facades/PointsFacade.h  

bool HasAttribute ( const FName& InAttribute
) const

 Check if attribute exist GeometryCollection/Facades/PointsFacade.h  

bool IsConst()

 Is the facade defined constant. GeometryCollection/Facades/PointsFacade.h  

bool IsValid()

 Is the facade defined constant. GeometryCollection/Facades/PointsFacade.h  

void TransformPoints ( const FTransform& InTransform
)

 Transform points GeometryCollection/Facades/PointsFacade.h  

Operators

Name Remarks Include Path Unreal Specifiers

FPointsFacade & operator= ( const FPointsFacade&
)

   GeometryCollection/Facades/PointsFacade.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page