1. Epic GamesDeveloper
  3. ACineCameraRigRail

ACineCameraRigRail

API > API/Plugins > API/Plugins/CineCameraRigs

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

Syntax

UCLASS (Blueprintable, Category="VirtualProduction")  
class ACineCameraRigRail : public ACameraRig_Rail

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

ACineCameraRigRail ( const FObjectInitializer& ObjectInitializer
)

   CineCameraRigRail.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AbsolutePositionOnRail float Custom parameter to drive current position CineCameraRigRail.h
  • EditAnywhere
  • Interp
  • BlueprintSetter="SetAbsolutePositionOnRail"
  • Category="Rail Controls"
  • Meta=(EditCondition="bUseAbsolutePosition")
bAttachLocationX bool Determines if camera mount inherits LocationX CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Attachment|Location"
bAttachLocationY bool Determines if camera mount inherits LocationY CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Attachment|Location"
bAttachLocationZ bool Determines if camera mount inherits LocationZ CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Attachment|Location"
bAttachRotationX bool Determines if camera mount inherits RotationX CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Attachment|Rotation"
bAttachRotationY bool Determines if camera mount inherits RotationY CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Attachment|Rotation"
bAttachRotationZ bool Determines if camera mount inherits RotationZ CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Attachment|Rotation"
bCompensateTimeScale bool If enabled, it compensates world time dilation in Speed/Duration mode so that the spline moves as intended speed regardless of recording time scale CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="DriveMode"
bDisplaySpeedHeatmap bool Enable speed visualization. Automatically disabled when position property is driven in Sequencer CineCameraRigRail.h
  • EditAnywhere
  • BlueprintSetter=SetDisplaySpeedHeatmap
  • Category="SplineVisualization"
  • Meta=(EditCondition="!IsSequencerDriven()")
bInheritAperture bool Determines if it can drive aperture on the attached actors CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Attachment|Camera"
bInheritFocalLength bool Determines if it can drive focal length on the attached actors CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Attachment|Camera"
bInheritFocusDistance bool Determines if it can drive focus distance on the attached actors CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Attachment|Camera"
bLoop bool Enable loop in speed or duration mode CineCameraRigRail.h
  • BlueprintReadWrite
  • Category="DriveMode"
  • Meta=(DeprecatedProperty, DeprecationMessage="Use LoopMode instead")
bPlay bool Determine if it can update position in Duration mode or Speed mode. If false, it pauses the update. CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="DriveMode"
bReverse bool Determine if it plays in reverse. CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="DriveMode"
  • Meta=(EditCondition="LoopMode != ECineCameraRigRailLoopMode::Bounce")
bUseAbsolutePosition bool Use AbsolutePosition metadata to parameterize the spline CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Rail Controls"
bUsePointRotation bool Use PointRotation metadata for attachment orientation. CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Rail Controls"
DriveMode ECineCameraRigRailDriveMode Drive Mode to update position in tick CineCameraRigRail.h
  • EditAnywhere
  • BlueprintSetter=SetDriveMode
  • Category="DriveMode"
LoopMode ECineCameraRigRailLoopMode   CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="DriveMode"
Speed float Specifies the drive speed of the rig rail in centimeter per second CineCameraRigRail.h
  • EditAnywhere
  • Interp
  • Category="DriveMode"
SpeedSampleCountPerSegment int32 Number of speed samples per spline segment CineCameraRigRail.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="SplineVisualization"
  • Meta=(ClampMin=1, EditCondition="bDisplaySpeedHeatmap")
SplineMeshMaterial TObjectPtr< UMaterialInterface > Material assigned to spline component mesh CineCameraRigRail.h
  • BlueprintSetter=SetSplineMeshMaterial
  • Category="SplineVisualization"
SplineMeshMIDs TArray< TObjectPtr< UMaterialInstanceDynamic > > Material Instance Dynamic created for the spline mesh CineCameraRigRail.h
  • Transient
  • BlueprintReadOnly
  • Category="SplineVisualization"
SplineMeshTexture TObjectPtr< UTexture2D > Texture that can be set to SplineMeshMIDs CineCameraRigRail.h
  • BlueprintSetter=SetSplineMeshTexture
  • Category="SplineVisualization"

Functions

Public

Name Remarks Include Path Unreal Specifiers

UCineSplineComponent * GetCineSplineComponent()

 Returns CineSplineComponent CineCameraRigRail.h
  • BlueprintPure
  • Category="Rail Components"

FVector GetVelocityAtPosition ( const float InPosition,
const float delta
) const

 Calculate internal velocity at the given position CineCameraRigRail.h
  • BlueprintCallable
  • Category="CineCameraRigRail"

bool IsSequencerDriven()

 Returns true if the rig rail is driven by Sequencer CineCameraRigRail.h  

virtual void PostLoad()

   CineCameraRigRail.h  

void SetAbsolutePositionOnRail ( float Value
)

 Set AbsolutePositionOnRail value CineCameraRigRail.h
  • BlueprintSetter

void SetDisplaySpeedHeatmap ( bool bEnable
)

 Enable display speed heatmap CineCameraRigRail.h
  • BlueprintSetter

void SetDriveMode ( ECineCameraRigRailDriveMode InMode
)

 Set drive mode CineCameraRigRail.h
  • BlueprintSetter

void SetSplineMeshMaterial ( UMaterialInterface* InMaterial
)

 Set spline mesh material CineCameraRigRail.h
  • BlueprintSetter

void SetSplineMeshTexture ( UTexture2D* InTexture
)

 Set texture used in the spline mesh material CineCameraRigRail.h
  • BlueprintSetter

Overridden from ACameraRig_Rail

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   CineCameraRigRail.h  

virtual void Tick ( float DeltaTime
)

   CineCameraRigRail.h  

Protected

Name Remarks Include Path Unreal Specifiers

float AdjustDeltaTime ( float InDeltaTime
) const

   CineCameraRigRail.h  

void DriveByParam ( float DeltaTime
)

   CineCameraRigRail.h  

void DriveBySpeed ( float DeltaTime
)

   CineCameraRigRail.h  

UMovieSceneFloatTrack * FindPositionTrack ( const UMovieSceneSequence* InSequence
)

   CineCameraRigRail.h  

float LastPositionValue()

   CineCameraRigRail.h  

void OnSequencerCheck()

 Check if the rig rail is driven by Sequencer CineCameraRigRail.h  

void OnSplineEdited()

   CineCameraRigRail.h  

bool PlayForward()

   CineCameraRigRail.h  

void SetMIDParameters()

   CineCameraRigRail.h  

float StartPositionValue()

   CineCameraRigRail.h  

void UpdateSpeedHeatmap()

   CineCameraRigRail.h  

void UpdateSpeedProgress()

   CineCameraRigRail.h  

void UpdateSplineMeshMID()

   CineCameraRigRail.h  

Overridden from ACameraRig_Rail

Name Remarks Include Path Unreal Specifiers

virtual void UpdateRailComponents()

   CineCameraRigRail.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page