1. Epic GamesDeveloper
  3. UZoneShapeComponent

UZoneShapeComponent

API > API/Plugins > API/Plugins/ZoneGraph

   
Name UZoneShapeComponent
Type class
Header File /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraph/Public/ZoneShapeComponent.h
Include Path #include "ZoneShapeComponent.h"

Syntax

UCLASS (MinimalAPI, ClassGroup=Custom, BlueprintType, ShowCategories=(Mobility),  
       HideCategories=(Physics, Collision, Lighting, Rendering, Mobile),  
       Meta=(BlueprintSpawnableComponent))  
class UZoneShapeComponent : public UPrimitiveComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UZoneShapeComponent ( const FObjectInitializer& ObjectInitializer
)

   ZoneShapeComponent.h  

Classes

Name Remarks
FOnShapeDataChanged  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bReverseLaneProfile bool True if lane profile should be reversed ZoneShapeComponent.h
  • Category=Zone
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(AllowPrivateAccess="true", IncludeInHash)
ConnectedShapes TArray< FZoneShapeConnection > Array of connections matching ShapeConnectors (not stored, these are refreshed from connectors). ZoneShapeComponent.h
  • Transient
LaneProfile FZoneLaneProfileRef Common lane template for whole shape ZoneShapeComponent.h
  • Category=Zone
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(AllowPrivateAccess="true", IncludeInHash)
OnLaneProfileChangedHandle FDelegateHandle   ZoneShapeComponent.h  
PerPointLaneProfiles TArray< FZoneLaneProfileRef > Array of lane templates indexed by the points when the shape is polygon. ZoneShapeComponent.h
  • Category=Zone
  • VisibleAnywhere
  • Meta=(IncludeInHash, EditCondition="false", EditConditionHides)
Points TArray< FZoneShapePoint > Shape points ZoneShapeComponent.h
  • Category=Zone
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(AllowPrivateAccess="true", IncludeInHash)
PolygonRoutingType EZoneShapePolygonRoutingType Polygon shape routing type ZoneShapeComponent.h
  • Category=Zone
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(AllowPrivateAccess="true", IncludeInHash, EditCondition="ShapeType == FZoneShapeType::Polygon")
ShapeConnectors TArray< FZoneShapeConnector > Connectors for other shapes (not stored, these are refreshed from points). ZoneShapeComponent.h
  • Transient
ShapeDataChangedEvent FOnShapeDataChanged   ZoneShapeComponent.h  
ShapeType FZoneShapeType Shape type, spline or polygon ZoneShapeComponent.h
  • Category=Zone
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(AllowPrivateAccess="true", IncludeInHash)
Tags FZoneGraphTagMask Zone tags, the lanes inherit zone tags. ZoneShapeComponent.h
  • Category=Zone
  • EditAnywhere
  • BlueprintReadWrite
  • Meta=(AllowPrivateAccess="true", IncludeInHash)

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddUniquePerPointLaneProfile ( const FZoneLaneProfileRef& NewLaneProfileRef
)

 Adds new one if one does not exists ZoneShapeComponent.h  

void ClearPerPointLaneProfiles()

 Removes per point lane templates. ZoneShapeComponent.h  

void CompactPerPointLaneProfiles()

 Removes unused items from the per point lane template array. ZoneShapeComponent.h  

const FZoneLaneProfileRef & GetCommonLaneProfile()

   ZoneShapeComponent.h  

TConstArrayView< FZoneShapeConnection > GetConnectedShapes()

   ZoneShapeComponent.h  

TArray< FZoneShapePoint > & GetMutablePoints()

   ZoneShapeComponent.h  

FZoneGraphTagMask & GetMutableTags()

   ZoneShapeComponent.h  

int32 GetNumPoints()

   ZoneShapeComponent.h  

int32 GetNumSegments()

   ZoneShapeComponent.h  

TConstArrayView< FZoneLaneProfileRef > GetPerPointLaneProfiles()

   ZoneShapeComponent.h  

TConstArrayView< FZoneShapePoint > GetPoints()

   ZoneShapeComponent.h  

void GetPolygonLaneProfiles ( TArray< FZoneLaneProfile >& OutLaneProfiles
) const

   ZoneShapeComponent.h  

EZoneShapePolygonRoutingType GetPolygonRoutingType()

   ZoneShapeComponent.h  

const FZoneShapeConnector * GetShapeConnectorByPointIndex ( int32 PointIndex
) const

   ZoneShapeComponent.h  

TConstArrayView< FZoneShapeConnector > GetShapeConnectors()

   ZoneShapeComponent.h  

uint32 GetShapeHash()

   ZoneShapeComponent.h  

FZoneShapeType GetShapeType()

   ZoneShapeComponent.h
  • Category=Zone
  • BlueprintPure

void GetSplineLaneProfile ( FZoneLaneProfile& OutLaneProfile
) const

   ZoneShapeComponent.h  

FZoneGraphTagMask GetTags()

   ZoneShapeComponent.h
  • Category=Zone
  • BlueprintPure

bool IsLaneProfileReversed()

   ZoneShapeComponent.h
  • Category=Zone
  • BlueprintPure

bool IsShapeClosed()

 Returns true if the shape is closed form. ZoneShapeComponent.h  

FOnShapeDataChanged & OnShapeDataChanged()

   ZoneShapeComponent.h  

void SetCommonLaneProfile ( const FZoneLaneProfileRef& LaneProfileRef
)

 Sets lane profile which is used for spline lanes, and polygon points which are set to Inherit. ZoneShapeComponent.h  

void SetPolygonRoutingType ( const EZoneShapePolygonRoutingType NewType
)

 Sets the polygon routing type. ZoneShapeComponent.h
  • Category=Zone
  • BlueprintCallable

bool SetReverseLaneProfile ( bool bReverse
)

 Set whether common lane profile should be reversed. ZoneShapeComponent.h
  • Category=Zone
  • BlueprintCallable

void SetShapeType ( FZoneShapeType Type
)

 Sets shape type. ZoneShapeComponent.h
  • Category=Zone
  • BlueprintCallable

void SetTags ( const FZoneGraphTagMask NewTags
)

 Sets shape tags. ZoneShapeComponent.h
  • Category=Zone
  • BlueprintCallable

void UpdateConnectedShapes()

 Updates how shape connectors are connected to other shapes. ZoneShapeComponent.h  
Updates how shape connectors are connected to other shapes. ZoneShapeComponent.h  

void UpdatePointRotationAndTangent ( int32 PointIndex
)

 Calculates rotation and tangent for a specific point. ZoneShapeComponent.h  

void UpdateShape()

 Updates shape, calculates auto tangents, and adjusts lane points to match the lane templates, updates connectors and connections. ZoneShapeComponent.h  

void UpdateShapeConnectors()

 Updates shape connectors from the points. ZoneShapeComponent.h  

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual FPrimitiveSceneProxy * CreateSceneProxy()

   ZoneShapeComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

   ZoneShapeComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void OnRegister()

   ZoneShapeComponent.h  

virtual void OnUnregister()

   ZoneShapeComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsEditorOnly()

   ZoneShapeComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   ZoneShapeComponent.h  

virtual void PostEditImport()

   ZoneShapeComponent.h  

virtual void PostEditUndo()

   ZoneShapeComponent.h  

virtual void PostLoad()

   ZoneShapeComponent.h  

virtual void Serialize ( FArchive& Ar
)

   ZoneShapeComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page