RTC DEFINITION PROPERTIES

This page lists the different elements and attributes required to generate properly formed XML for the RTC camera system. More information about RTCs can be found here, and examples of RTC XML can be found here.

 

 

<SimMission.RTCSequencer>

The <SimMission.RTCSequencer> element is the container element for all RTC events, and you can use the following XML sub-elements when defining one:

 

Element Description Type Unique Required
<InstanceId> GUID for referencing the RTCSequencer. GUID Yes Yes
<Descr> Description, using as a name. Text Yes Yes
<Skippable> If we can skip the animations. Default is FALSE. Bool Yes No
<Pausable> If we can pause the animations. Default is TRUE. Bool Yes No
<LoopAnimation> If the RTCSequencer should loop. Bool Yes No
<Shuffle> If we should shuffle the order of actions/ RTCShots/ RTCSequence. Default is FALSE. Bool Yes No
<Actions> Actions to play (can be an RTCSequence or other RTCSequencer). Actions No No
<RTCSequence> RTCSequence to play. RTCSequence No No
<FadeFromBlack> If true the RTCSequencer starts with a fade from black. Default is FALSE. Bool Yes No
<FadeToBlack> If true the RTCSequencer ends with a fade to black. Default is FALSE. Bool Yes No
<ReuseSameCycle> If set to true, will shuffle the RTCSequencer at the end of the cycle. Default is TRUE. Bool Yes No
<NeedPreload> If true the RTCSequencer needs specific streaming. Default is FALSE. Bool Yes No
<AllowPlayerControl> If true the RTCSequencer is shuffled again at the end of a cycle. Default is FALSE. Bool Yes No
<ShotCount> Number or actions played in the RTCSequencer, if not specified, play all animation. Default is -1. Integer Yes No

 

 

<RTCSequence>

The <RTCSequence> element is an element used to contain one or more animations to be included as part of an RTCSequencer. Note that this element cannot be used outside of an <SimMission.RTCSequencer> element. You can use the following XML when defining an RTCSequence:

 

Element Description Type Unique Required
<ShotType> The type of RTC shot to be played to the user.

ENUM

Aircraft: For aircraft only

Airport: For airports only

POI: For POI only

Yes Yes
<ShotCount> Number of animations played in the RTCSequence. If not specified or equal to -1, play all the possible animations (max. 40, default -1.) Integer Yes No
<RootPosition> Position where to place the animation

ENUM

None: No specific position, will be on the plane

 

DefaultRunway: Will be placed on the default runway

 

PlayerAtSequenceStart: Will be at the place the plane starts

 

NoSpecification: If it's an airport type it will be the same as for "DefaultRunway", if its aircraft type, it will be the samne as for "None"

 

RunwayStart: Start of the default runway

 

RunwayEnd: End of the default runway

 

RunwayCenter: Center of the default runway

 

Tower: First tower of the airport

 

Parking: First parking of the airport


ActivePOI: Will be on the active Point Of Interest

Yes No
<FileToInclude> If present, then, any animations need to come from a glTF file matching the filname given Text No No
<FileToExclude> If present, then, any animations must not come from a glTF file matching the filename given Text No No
<AnimationToInclude> Any selected animation for the RTCSequence needs to contain one of the names in any AnimationToInclude Text No No
<AnimationToExclude> Any selected animation for the RTCSequence must not contain one of the names in any AnimationToInclude Text No No
<PathToInclude> A path to be included in the RTC. Allows you to include subfolders that are not included by default Text No No
<PathToExclude> A path to be excluded in the RTC Text No No
<DepthOfField> To manage the depth of field (blur amount and focal distance)

ELEMENT

See information on the <DepthOfField> element (below) for more details.

 Yes No
<FadeFromBlack> If true the RTCSequencer starts with a fade from black Bool Yes No
<FadeToBlack> If true the RTCSequencer ends with a fade to black Bool Yes No
<Fov> Fov (zoom) parameters

ELEMENT

See information on the <Fov> element (below) for more details.

 Yes No
<Shuffle> If we should shuffle the order of RTCShot Bool Yes No
<CameraLinkedToPlayer> If true the camera of the animation is linked to the player (ie: the camera will follow the player). Defaults are:
Aircraft: True
Airport: False
POI: False 		Bool Yes No
<TargetLinkedToPlayer> If true the target of the animation is linked to the player (ie: the camera will always look at the player). Defaults are:
Aircraft: True
Airport: False
POI: False 		Bool Yes No

 

 

<RTCShot>

The RTC shot element can be used to define a single RTC camera shot as part of an RTCSequencer or RTCSequence. The element itself has the following attribute:

 

Attribute Description Type Unique Required
InstanceId GUID referencing the Object to execute GUID Yes Yes

 

 

Within this element you can use the following XML sub-elements:

 

Element Description Type Unique Required
<Descr> Name of the action Text Yes Yes
<LinkedToPlayer> Set if the animation should be linked to the player. Default is FALSE Bool Yes No
<AttachedWorldObject> Attaches the animation to an object AttachedWorldObject Yes No
<WorldPosition> Position where to place the animation WorldPosition Yes No
<RootPosition> Position where to place the animation

ENUM

None: No specific position, will be on the plane

 

DefaultRunway: Will be placed on the default runway

 

PlayerAtSequenceStart: Will be at the place the plane starts

 

NoSpecification: If it's an airport type it will be the same as for "DefaultRunway", if its aircraft type, it will be the same as for "None"

 

RunwayStart: Start of the default runway

 

RunwayEnd: End of the default runway

 

RunwayCenter: Center of the default runway

 

Tower: First tower of the airport

 

Parking: First parking of the airport


ActivePOI: Will be on the active Point Of Interest

Yes No
<Orientation> Orientation of the animation pbh Yes No
<FileName>

use <FileGUID>

 Text Yes No
<FileGUID> GUID of the glTF where the animation is GUID Yes Yes
<AnimationName> Name of the animation in the glTF Text Yes Yes
<CameraNodeName> Name of the camera node of the animation in the glTF file. Default is AnimationName_CAMERA Text Yes No
<TargetNodeName> Name of the target node of the animation in the glTF file. Default is AnimationName_TARGET Text Yes No
<Skippable> If we can skip the animation. Default is FALSE. Bool Yes No
<Pausable> If we can pause the animations. Defualt is TRUE. Bool Yes No
<DepthOfField> To manage the depth of field (blur amount and focal distance)

ELEMENT

See information on the <DepthOfField> element (below) for more details.

 Yes No
<FadeFromBlack> If true the RTCSequencer starts with a fade from black. Default is FALSE. Bool Yes No
<FadeToBlack> If true the RTCSequencer ends with a fade to black. Default is FALSE. Bool Yes No
<Camerabehaviors> Apply a set of behaviors

ELEMENT

See information on <CameraBehaviors> element (below) for more details.

 No No
<Fov> Fov (zoom) parameters

ELEMENT

See information on the <Fov> element (below) for more details.

 Yes No
<CameraLinkedToPlayer> If true the camera of the animation is linked to the player (ie: the camera will follow the player). Default is FALSE. Bool Yes No
<TargetLinkedToPlayer> If true the target of the animation is linked to the player (ie: the camera will always look at the player). Default is FALSE. Bool Yes No

 

 

<RTCCameraShot>

The <RTCCameraShot> element describes an animation that is able to go through various points called "ShotPoints", which are themselves defined by the cameras.cfg file. This permits you to create RTCs without using any 3D software or create any glTF files. The <RTCCameraShot> element has the following attribute:

 

Attribute Description Type Unique Required
InstanceId GUID referencing the RTCSequencer, must be unique GUID Yes Yes

 

The XML sub-elements for <RTCCameraShot> are as follows:

 

Element Description Type Unique Required
Descr Description, using as a name Text Yes Yes
RTCShotPoints Contain the list of RTCShotPoint Element (see below) Yes Yes


<RTCShotPoints> and <RTCShotPoint>

The <RTCShotPoints> element will contain one or more <RTCShotPoint> element, depending on how many cameras you want to use. The <RTCShotPoint> has the following XML elements:

 

Element Description Type Unique Required
<CameraName> Name of the camera Text Yes No
<CameraGUID> GUID of the camera GUID Yes Yes
<CameraLinkedToPlayer> If true the camera of the animation is linked to the player (ie: the camera will follow the player).Default is TRUE. bool Yes No
<TargetLinkedToPlayer> If true the target of the animation is linked to the player (ie: the camera will always look at the player). Default is FALSE. Bool Yes No
<RootPosition> Position where to place the animation

ENUM

None: No specific position, will be on the plane

 

DefaultRunway: Will be placed on the default runway

 

PlayerAtSequenceStart: Will be at the place the plane starts

 

NoSpecification: If it's an airport type it will be the same as for "DefaultRunway", if its aircraft type, it will be the same as for "None"

 

RunwayStart: Start of the default runway

 

RunwayEnd: End of the default runway

 

RunwayCenter: Center of the default runway

 

Tower: First tower of the airport

 

Parking: First parking of the airport


ActivePOI: Will be on the active Point Of Interest

Yes No
<ShotDuration> Duration between the previous shotPoint and the actual one in seconds. Default is 1. float Yes No
<Interpolation> Type of interpolation : how quickly depending on the time will the camera move. Default is Linear.

ENUM

Linear: Camera is moving in a Linear way all the time

Exponential: Begin slowly, then end quickly

Logarithmic: Begin quickly, end slowly

PushEdge: Begin and end is slow, middle is quick

PushMid: Begin and end is quick, middle is slow

 Yes No
<DepthOfField> To manage the depth of field (blur amount and focal distance)

ELEMENT

See information on the <DepthOfField> element (below) for more details.

 Yes No

 

 

<DepthOfField>

The RTCSequence element and the RTCShot element can both contain <DepthOfField> to set different depth of field effects using the following XML:

 

Element Description Type Unique Required
<Blur>

Blur value where:

0.1 = small amount of blur

2.0 = a lot of blur

Default is 0.25.

 Float Yes Yes
<FocalDist> If a value larger than 0 is used then the focal distance will be constant and not automatic. Default is 0. Float Yes No
<Activate> Permits you to activate/ deactivate the DoF, where deactivating it will mean no blur at all. Default is TRUE. Bool Yes No
<AutoFocusSpeed>

Coefficient for the autofocus speed between 0 and 1 where:

0 = will not do any focus

1 = instant focus

Default is 0.05.

 Float Yes No
<ApplyFrontFocus> If set to true the blur - depending on the focus distance - will be applied on foreground. Default is FALSE. Bool Yes No

 

 

<Fov>

The RTCSequence element and the RTCShot element can contain <Fov> to set different field of view (FOV) parameters using the following XML:

 

Element Description Type Unique Required
<FovLength>

Value of the zoom in radians where:

minimum of 0.1 = zoomed in really close (approx. 5º)

maximum of 2.75 = looking from very far away (approx. 160º)

Default is 0.8 (approx. 45º).

 Float Yes No
<SmoothTimeFov> Timing of the change from the old FOV value to the new value in seconds. Default is 0.0. Float Yes No
<UseGltfFov> Use the FOV that is defined as part of the glTF animation being used. Default is FALSE. Bool Yes No

 

 

<CameraBehaviors>

<CameraBehaviors> contains one or more <CameraBehavior> elements, which define how the camera should behave during the RTC. The sub-element XML it uses is:

 

Element Description Type Unique Required
<CameraBehavior> Describe a behavior Element (See table below) No No

 

<CameraBehavior> is what defines how the camera should behave during the RTC, and you use the following XML:

 

Element Attribute Description Type Unique Required
  CameraBehaviorType Type of the behavior

ENUM

None: No specific behavior

 

ActorTarget: The camera will follow a given actor, in which case the attribute should be the name of the actor

 Yes No
<CameraBehaviorAttributes>   Attributes link to the type Element (see text below) No No

 

The <CameraBehaviorAttributes> will permit you to give parameters to the behavior(s) we want to have, and can only have the <CameraBehaviorStrAttribute> within it. This element has the following attribute:

 

Element Description Type Unique Required
<CameraBehaviorStrAttribute> Describe a behavior Text Yes No