Navigation
API > API/Plugins > API/Plugins/CineCameraRigs
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- AActor
- ACameraRig_Rail
- ACineCameraRigRail
References
| Module | CineCameraRigs |
| Header | /Engine/Plugins/Experimental/CineCameraRigs/Source/CineCameraRigs/Public/CineCameraRigRail.h |
| Include | #include "CineCameraRigRail.h" |
Syntax
UCLASS&40;Blueprintable, Category&61;"VirtualProduction"&41;
class ACineCameraRigRail : public ACameraRig_Rail
Variables
| Type | Name | Description | |
|---|---|---|---|
| float | AbsolutePositionOnRail | Custom parameter to drive current position | |
| bool | bAttachLocationX | Determines if camera mount inherits LocationX | |
| bool | bAttachLocationY | Determines if camera mount inherits LocationY | |
| bool | bAttachLocationZ | Determines if camera mount inherits LocationZ | |
| bool | bAttachRotationX | Determines if camera mount inherits RotationX | |
| bool | bAttachRotationY | Determines if camera mount inherits RotationY | |
| bool | bAttachRotationZ | Determines if camera mount inherits RotationZ | |
| bool | bDisplaySpeedHeatmap | Enable speed visualization. Automatically disabled when position property is driven in Sequencer | |
| bool | bInheritAperture | Determines if it can drive aperture on the attached actors | |
| bool | bInheritFocalLength | Determines if it can drive focal length on the attached actors | |
| bool | bInheritFocusDistance | Determines if it can drive focus distance on the attached actors | |
| bool | bLoop | Enable loop in speed or duration mode | |
| bool | bSequencerDriven | ||
| bool | bUseAbsolutePosition | Use AbsolutePosition metadata to parameterize the spline | |
| bool | bUsePointRotation | Use PointRotation metadata for attachment orientation. | |
| TObjectPtr< class UCineSplineComponent > | CineSplineComponent | ||
| ECineCameraRigRailDriveMode | DriveMode | Drive Mode to update position in tick | |
| FTimerHandle | SequencerCheckHandle | ||
| float | Speed | Specifies the drive speed of the rig rail in centimeter per second | |
| float | SpeedProgress | ||
| int32 | SpeedSampleCountPerSegment | Number of speed samples per spline segment | |
| TObjectPtr< UMaterialInterface > | SplineMeshMaterial | Material assigned to spline component mesh | |
| TArray< TObjectPtr< UMaterialInstanceDynamic > > | SplineMeshMIDs | Material Instance Dynamic created for the spline mesh | |
| TObjectPtr< UTexture2D > | SplineMeshTexture | Texture that can be set to SplineMeshMIDs |
Constructors
| Type | Name | Description | |
|---|---|---|---|
ACineCameraRigRail
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | DriveByParam
(
float DeltaTime |
||
| void | DriveBySpeed
(
float DeltaTime |
||
| UMovieSceneFloatTrack * | FindPositionTrack
(
const UMovieSceneSequence* InSequence |
||
| UCineSplineComponent * | Returns CineSplineComponent | ||
| FVector | GetVelocityAtPosition
(
const float InPosition, |
Calculate internal velocity at the given position | |
| bool | Returns true if the rig rail is driven by Sequencer | ||
| float | |||
| void | Check if the rig rail is driven by Sequencer | ||
| void | |||
| void | SetDisplaySpeedHeatmap
(
bool bEnable |
Enable display speed heatmap | |
| void | SetDriveMode
(
ECineCameraRigRailDriveMode InMode |
Set drive mode | |
| void | |||
| void | SetSplineMeshMaterial
(
UMaterialInterface* InMaterial |
Set spline mesh material | |
| void | SetSplineMeshTexture
(
UTexture2D* InTexture |
Set texture used in the spline mesh material | |
| float | |||
| void | |||
| void | |||
| void |
Overridden from ACameraRig_Rail
| Type | Name | Description | |
|---|---|---|---|
| void | Makes sure all components are arranged properly. |
Overridden from AActor
| Type | Name | Description | |
|---|---|---|---|
| void | Tick
(
float DeltaSeconds |
Function called every frame on this Actor. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally | |
| void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |