Navigation
API > API/Plugins > API/Plugins/PCG > API/Plugins/PCG/Data
Inheritance Hierarchy
- UObject
- UPCGData
- UPCGSpatialData
- UPCGSpatialDataWithPointCache
- UPCGPolyLineData
- UPCGLandscapeSplineData
- UPCGSplineData
- UPCGWaterSplineData
References
| Module | PCG |
| Header | /Engine/Plugins/PCG/Source/PCG/Public/Data/PCGPolyLineData.h |
| Include | #include "Data/PCGPolyLineData.h" |
Syntax
UCLASS (Abstract, BlueprintType, ClassGroup=(Procedural))
class UPCGPolyLineData : public UPCGSpatialDataWithPointCache
Functions
| Type | Name | Description | |
|---|---|---|---|
   |
float | GetAlphaAtDistance
(
int SegmentIndex, |
Get a value [0,1] representing how far along the point is to the end of the line. |
   |
FVector::FReal | GetCurvatureAtDistance
(
int SegmentIndex, |
Get the curvature at a distance along the line. |
   |
FVector::FReal | GetDistanceAtSegmentStart
(
int SegmentIndex |
Get the cumulative distance along the line to the start of a segment. |
   |
float | GetInputKeyAtDistance
(
int SegmentIndex, |
Get the input key at a distance along the line. |
   |
FVector::FReal | GetLength () |
Get the total length of the line. |
   |
FVector | GetLocationAtDistance
(
int SegmentIndex, |
Get the location at a distance along the line. |
   |
int | Get the number of segments in this line. | |
   |
FVector::FReal | GetSegmentLength
(
int SegmentIndex |
Get the length of a specific segment of the line. |
   |
void | GetTangentsAtSegmentStart
(
int SegmentIndex, |
Get the arrive and leave tangents for a control point via its segment index. |
   |
FTransform | GetTransform () |
Get the world-space transform of the entire line. |
   |
FTransform | GetTransformAtDistance
(
int SegmentIndex, |
Get the location at a distance along the line. |
   |
bool | True if the line holds custom metadata. | |
   |
bool | IsClosed () |
True if the line is a closed loop. |
   |
void | WriteMetadataToPoint
(
float InputKey, |
If a PolyLine subtype has custom metadata, it can use this virtual call to write that into the PCG Metadata per-point. |
Overridden from UPCGSpatialData
| Type | Name | Description | |
|---|---|---|---|
   |
FBox | GetBounds () |
Returns the full bounds (including density fall-off) of the data |
   |
int | GetDimension () |
Returns the dimension of the data type, which has nothing to do with the dimension of its points |
Overridden from UPCGData
| Type | Name | Description | |
|---|---|---|---|
   |
EPCGDataType | GetDataType () |