Navigation
API > API/Plugins > API/Plugins/PCG
| Name | UPCGPolyLineData |
| Type | class |
| Header File | /Engine/Plugins/PCG/Source/PCG/Public/Data/PCGPolyLineData.h |
| Include Path | #include "Data/PCGPolyLineData.h" |
Syntax
UCLASS (MinimalAPI, Abstract, BlueprintType, ClassGroup=(Procedural))
class UPCGPolyLineData : public UPCGSpatialDataWithPointCache
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPCGData → UPCGSpatialData → UPCGSpatialDataWithPointCache → UPCGPolyLineData
Derived Classes
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TypeInfo | FPCGDataTypeInfoPolyline | Data/PCGPolyLineData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AllocateMetadataEntries() |
Data/PCGPolyLineData.h | ||
virtual float GetAlphaAtDistance
(
int SegmentIndex, |
Get a value [0,1] representing how far along the point is to the end of the line. | Data/PCGPolyLineData.h |
|
virtual TConstArrayView< PCGMetadataEntryKey > GetConstVerticesEntryKeys() |
Data/PCGPolyLineData.h | ||
virtual double GetCurvatureAtDistance
(
int SegmentIndex, |
Get the curvature at a distance along the line. | Data/PCGPolyLineData.h |
|
virtual double GetDistanceAtSegmentStart
(
int SegmentIndex |
Get the cumulative distance along the line to the start of a segment. | Data/PCGPolyLineData.h |
|
virtual float GetInputKeyAtAlpha
(
float Alpha |
Get the input key from the normalized distance of [0, 1] across the entire the poly line. | Data/PCGPolyLineData.h |
|
virtual float GetInputKeyAtDistance
(
int SegmentIndex, |
Get the input key at a distance along the line. | Data/PCGPolyLineData.h |
|
virtual double GetLength() |
Get the total length of the line. | Data/PCGPolyLineData.h |
|
virtual FVector GetLocationAtAlpha
(
float Alpha |
Get the location of the point at the normalized [0, 1] parameter across the entire the poly line. | Data/PCGPolyLineData.h |
|
virtual FVector GetLocationAtDistance
(
int SegmentIndex, |
Get the location at a distance along the line. | Data/PCGPolyLineData.h |
|
virtual TArrayView< PCGMetadataEntryKey > GetMutableVerticesEntryKeys() |
Data/PCGPolyLineData.h | ||
virtual int GetNumSegments () |
Get the number of segments in this line. | Data/PCGPolyLineData.h |
|
virtual int GetNumVertices() |
Data/PCGPolyLineData.h |
|
|
virtual double GetSegmentLength
(
int SegmentIndex |
Get the length of a specific segment of the line. | Data/PCGPolyLineData.h |
|
virtual void GetTangentsAtSegmentStart
(
int SegmentIndex, |
Get the arrive and leave tangents for a control point via its segment index. | Data/PCGPolyLineData.h |
|
virtual FTransform GetTransform() |
Get the world-space transform of the entire line. | Data/PCGPolyLineData.h |
|
virtual FTransform GetTransformAtAlpha
(
float Alpha |
Get the full transform at the normalized [0, 1] parameter across the entire the poly line. | Data/PCGPolyLineData.h |
|
virtual FTransform GetTransformAtDistance
(
int SegmentIndex, |
Get the location at a distance along the line. | Data/PCGPolyLineData.h | |
virtual bool IsClosed() |
True if the line is a closed loop. | Data/PCGPolyLineData.h |
|
FTransform K2_GetTransformAtDistance
(
int SegmentIndex, |
Get the location at a distance along the line. | Data/PCGPolyLineData.h |
|
virtual void WriteMetadataToPoint
(
float InputKey, |
This function should be called in the Sample/Project point function, but can also be called if the sampling is done manually. | Data/PCGPolyLineData.h |
|
Overridden from UPCGSpatialData
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FBox GetBounds() |
Returns the full bounds (including density fall-off) of the data | Data/PCGPolyLineData.h | |
virtual int GetDimension() |
Returns the dimension of the data type, which has nothing to do with the dimension of its points | Data/PCGPolyLineData.h |
Overridden from UPCGData
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSEPCGDataType GetDataType() |
@todo_pcg To be deprecated when we switch to the new type | Data/PCGPolyLineData.h | |
virtual const FPCGDataTypeBaseId & GetDataTypeId() |
Data/PCGPolyLineData.h |