1. Epic GamesDeveloper
  3. UCineSplineComponent

UCineSplineComponent

API > API/Plugins > API/Plugins/CineCameraRigs

   
Name UCineSplineComponent
Type class
Header File /Engine/Plugins/Experimental/CineCameraRigs/Source/CineCameraRigs/Public/CineSplineComponent.h
Include Path #include "CineSplineComponent.h"

Syntax

UCLASS (ClassGroup=Utility, ShowCategories=(Mobility),  
       HideCategories=(Physics, Collision, Lighting, Rendering, Mobile),  
       Meta=(BlueprintSpawnableComponent))  
class UCineSplineComponent : public USplineComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UCineSplineComponent ( const FObjectInitializer& ObjectInitializer
)

   CineSplineComponent.h  

Classes

Name Remarks
FOnSplineEdited_BP  

Typedefs

Name Type Remarks Include Path
FOnSplineEdited TMulticastDelegate_NoParams< void >   CineSplineComponent.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bShouldVisualizeNormalizedPosition bool Toggle if visualizer displays normalized position or absolute position CineSplineComponent.h
  • EditAnywhere
  • Category="CineSplineEditor"
  • Meta=(InlineEditConditionToggle=true)
bShouldVisualizePointRotation bool Whether point rotation arrows should be displayed in visualizer CineSplineComponent.h
  • EditAnywhere
  • Category="CineSplineEditor"
  • Meta=(InlineEditConditionToggle=true)
bShouldVisualizeSplineLength bool Whether spline length value should be displayed in visualizer CineSplineComponent.h
  • EditAnywhere
  • Category="CineSplineEditor"
  • Meta=(InlineEditConditionToggle=true)
CameraSplineDefaults FCineSplineCurveDefaults Defaults which are used to propagate values to spline points on instances of this in the world CineSplineComponent.h
  • Category=Camera
  • EditDefaultsOnly
CineSplineMetadata TObjectPtr< UCineSplineMetadata > Pointer to metadata CineSplineComponent.h
  • Instanced
OnSplineEdited FOnSplineEdited   CineSplineComponent.h  
OnSplineEdited_BP FOnSplineEdited_BP Event trigerred when spline is edited CineSplineComponent.h
  • BlueprintAssignable
  • Category="CineSpline"
  • Meta=(DisplayName="OnSplineEdited")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddSplineDataAtPosition ( const float InPosition,
const FCineSplinePointData& InPointData
)

 Add a new spline point data at the given custom position CineSplineComponent.h
  • BlueprintCallable
  • Category="CineSpline"

void ApplyComponentInstanceData ( FCineSplineInstanceData* ComponentInstanceData,
const bool bPostUCS
)

   CineSplineComponent.h  

bool FindSplineDataAtPosition ( const float InPosition,
int32& OutIndex,
const float Tolerance
) const

 Returns true if there is a spline point at given custom position CineSplineComponent.h
  • BlueprintCallable
  • BlueprintPure
  • Category="CineSpline"

float GetInputKeyAtPosition ( const float InPosition
) const

 Get input key value from custom position CineSplineComponent.h
  • BlueprintCallable
  • Category="CineSpline"

FQuat GetPointRotationAtSplineInputKey ( float InKey
) const

 Get camera rotation metadata value along the spline at spline input key CineSplineComponent.h
  • BlueprintCallable
  • Category="CineSpline"

FQuat GetPointRotationAtSplinePoint ( int32 Index
) const

 Get camera rotation metadata property value along the spline at spline point CineSplineComponent.h
  • BlueprintCallable
  • Category="CineSpline"

float GetPositionAtInputKey ( const float InKey
) const

 Get custom position value at spline input key CineSplineComponent.h
  • BlueprintCallable
  • Category="CineSpline"

FCineSplinePointData GetSplineDataAtPosition ( const float InPosition
) const

 Get a spline point data at the given custom position CineSplineComponent.h
  • BlueprintCallable
  • Category="CineSpline"

void SetAbsolutePositionAtSplinePoint ( const int32 PointIndex,
const float value
)

 Set custom position metadata at a given spline point CineSplineComponent.h
  • BlueprintCallable
  • Category="CineSpline"

void SetApertureAtSplinePoint ( const int32 PointIndex,
const float value
)

 Set aperture metadata at a given spline point CineSplineComponent.h
  • BlueprintCallable
  • Category="CineSpline"

void SetFocalLengthAtSplinePoint ( const int32 PointIndex,
const float Value
)

 Set focal lenght metadata at a given splint point CineSplineComponent.h
  • BlueprintCallable
  • Category="CineSpline"

void SetFocusDistanceAtSplinePoint ( const int32 PointIndex,
const float value
)

 Set focus distance metadata at a given spline point CineSplineComponent.h
  • BlueprintCallable
  • Category="CineSpline"

void SetPointRotationAtSplinePoint ( const int32 PointIndex,
const FQuat value
)

 Set camera rotation metadata at a given spline point CineSplineComponent.h
  • BlueprintCallable
  • Category="CineSpline"

void UpdateSplineDataAtIndex ( const int InIndex,
const FCineSplinePointData& InPointData
)

 Update spline point data at the given spline point CineSplineComponent.h
  • BlueprintCallable
  • Category="CineSpline"

Overridden from USplineComponent

Name Remarks Include Path Unreal Specifiers

virtual bool AllowsSplinePointScaleEditing()

   CineSplineComponent.h  
Spline component interface CineSplineComponent.h  
  CineSplineComponent.h  

virtual void UpdateSpline()

 Update the spline tangents and SplineReparamTable. And trigers OnSplineEdited delegates CineSplineComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual TStructOnScope< FActorComponentInstanceData > GetComponentInstanceData()

   CineSplineComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   CineSplineComponent.h  

virtual void PostLoad()

   CineSplineComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

void SynchronizeProperties()

   CineSplineComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page