Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → AActor → ACameraRig_Rail → ACineCameraRigRail
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 |
|
| bAttachLocationX | bool | Determines if camera mount inherits LocationX | CineCameraRigRail.h |
|
| bAttachLocationY | bool | Determines if camera mount inherits LocationY | CineCameraRigRail.h |
|
| bAttachLocationZ | bool | Determines if camera mount inherits LocationZ | CineCameraRigRail.h |
|
| bAttachRotationX | bool | Determines if camera mount inherits RotationX | CineCameraRigRail.h |
|
| bAttachRotationY | bool | Determines if camera mount inherits RotationY | CineCameraRigRail.h |
|
| bAttachRotationZ | bool | Determines if camera mount inherits RotationZ | CineCameraRigRail.h |
|
| 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 |
|
| bDisplaySpeedHeatmap | bool | Enable speed visualization. Automatically disabled when position property is driven in Sequencer | CineCameraRigRail.h |
|
| bInheritAperture | bool | Determines if it can drive aperture on the attached actors | CineCameraRigRail.h |
|
| bInheritFocalLength | bool | Determines if it can drive focal length on the attached actors | CineCameraRigRail.h |
|
| bInheritFocusDistance | bool | Determines if it can drive focus distance on the attached actors | CineCameraRigRail.h |
|
| bLoop | bool | Enable loop in speed or duration mode | CineCameraRigRail.h |
|
| bPlay | bool | Determine if it can update position in Duration mode or Speed mode. If false, it pauses the update. | CineCameraRigRail.h |
|
| bReverse | bool | Determine if it plays in reverse. | CineCameraRigRail.h |
|
| bUseAbsolutePosition | bool | Use AbsolutePosition metadata to parameterize the spline | CineCameraRigRail.h |
|
| bUsePointRotation | bool | Use PointRotation metadata for attachment orientation. | CineCameraRigRail.h |
|
| DriveMode | ECineCameraRigRailDriveMode | Drive Mode to update position in tick | CineCameraRigRail.h |
|
| LoopMode | ECineCameraRigRailLoopMode | CineCameraRigRail.h |
|
|
| Speed | float | Specifies the drive speed of the rig rail in centimeter per second | CineCameraRigRail.h |
|
| SpeedSampleCountPerSegment | int32 | Number of speed samples per spline segment | CineCameraRigRail.h |
|
| SplineMeshMaterial | TObjectPtr< UMaterialInterface > | Material assigned to spline component mesh | CineCameraRigRail.h |
|
| SplineMeshMIDs | TArray< TObjectPtr< UMaterialInstanceDynamic > > | Material Instance Dynamic created for the spline mesh | CineCameraRigRail.h |
|
| SplineMeshTexture | TObjectPtr< UTexture2D > | Texture that can be set to SplineMeshMIDs | CineCameraRigRail.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCineSplineComponent * GetCineSplineComponent() |
Returns CineSplineComponent | CineCameraRigRail.h |
|
FVector GetVelocityAtPosition
(
const float InPosition, |
Calculate internal velocity at the given position | CineCameraRigRail.h |
|
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 |
|
void SetDisplaySpeedHeatmap
(
bool bEnable |
Enable display speed heatmap | CineCameraRigRail.h |
|
void SetDriveMode
(
ECineCameraRigRailDriveMode InMode |
Set drive mode | CineCameraRigRail.h |
|
void SetSplineMeshMaterial
(
UMaterialInterface* InMaterial |
Set spline mesh material | CineCameraRigRail.h |
|
void SetSplineMeshTexture
(
UTexture2D* InTexture |
Set texture used in the spline mesh material | CineCameraRigRail.h |
|
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 |
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 |