UPointSetComponent | Unreal Engine 5.6 Documentation

API > API/Plugins > API/Plugins/ModelingComponents

UPointSetComponent is a Component that draws a set of points, as small squares. Per-point Color and (view-space) Size is supported. Normals are not supported.

Points are inserted with an externally-defined ID, internally this is done via a TSparseArray. This class allocates a contiguous TArray large enugh to hold the largest ID. Using ReservePoints() may be beneficial for huge arrays.

The points are drawn as two triangles (ie a square) orthogonal to the view direction. The actual point size is calculated in the shader, and so a custom material must be used.


Name	UPointSetComponent
Type	class
Header File	/Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/Drawing/PointSetComponent.h
Include Path	#include "Drawing/PointSetComponent.h"

Syntax

UCLASS (MinimalAPI, Meta=(BlueprintSpawnableComponent))  
class UPointSetComponent : public UMeshComponent

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UPrimitiveComponent → UMeshComponent → UPointSetComponent

Implements Interfaces

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UPointSetComponent()		Drawing/PointSetComponent.h

Variables

Protected

Name	Type	Include Path
bBoundsDirty	bool	Drawing/PointSetComponent.h
Bounds	FBoxSphereBounds	Drawing/PointSetComponent.h
PointMaterial	TObjectPtr< const UMaterialInterface >	Drawing/PointSetComponent.h
Points	TSparseArray< FRenderablePoint >	Drawing/PointSetComponent.h

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
int32 AddPoint ( const FVector& InPosition, const FColor& InColor, const float InSize, const float InDepthBias )	Create and add a point to be rendered using the component.	Drawing/PointSetComponent.h
int32 AddPoint ( const FRenderablePoint& OverlayPoint )	Add a point to be rendered using the component.	Drawing/PointSetComponent.h
int32 AddPoints ( const TArray< FVector >& Positions, const FColor& InColor, const float InSize, const float InDepthBias )	Add points to be rendered using the component.	Drawing/PointSetComponent.h	BlueprintCallable Category="Point Set" Meta=(AutoCreateRefTerm="InColor")
void AddPoints ( int32 NumIndices, TFunctionRef< void(int32 Index, TArray< FRenderablePoint >&PointsOut)> PointGenFunc, int32 PointsPerIndexHint, bool bDeferRenderStateDirty )	Add a set of points for each index in a sequence	Drawing/PointSetComponent.h
void Clear()	Clear all primitives	Drawing/PointSetComponent.h	BlueprintCallable Category="Point Set"
const FRenderablePoint & GetPoint ( const int32 ID )	Retrieve a point with the given id.	Drawing/PointSetComponent.h
void InsertPoint ( const int32 ID, const FRenderablePoint& OverlayPoint )	Insert a point with the given ID into the set.	Drawing/PointSetComponent.h
bool IsPointValid ( const int32 ID ) const	Queries whether a point with the given ID exists	Drawing/PointSetComponent.h
void RemovePoint ( const int32 ID )	Remove a point from the set.	Drawing/PointSetComponent.h
void ReservePoints ( const int32 MaxID )	Reserve enough memory for up to the given ID	Drawing/PointSetComponent.h
void SetAllPointsColor ( const FColor& NewColor )	Sets the color of all points currently in the set.	Drawing/PointSetComponent.h
void SetAllPointsDepthBias ( float NewDepthBias )	Sets the depth bias of all points currently in the set.	Drawing/PointSetComponent.h
void SetAllPointsSize ( float NewSize )	Sets the size of all points currently in the set.	Drawing/PointSetComponent.h
void SetPointColor ( const int32 ID, const FColor& NewColor )	Sets the color of a point	Drawing/PointSetComponent.h
void SetPointMaterial ( UMaterialInterface* InPointMaterial )	Specify material which handles points	Drawing/PointSetComponent.h	BlueprintCallable Category="Point Set"
void SetPointPosition ( const int32 ID, const FVector& NewPosition )	Sets the position of a point (assumes its existence).	Drawing/PointSetComponent.h
void SetPointSize ( const int32 ID, const float NewSize )	Sets the size of a point	Drawing/PointSetComponent.h

Navigation