Guide ‐ Useful to know ‐ CineCam wiki

This guide applies to both 2D and 3D!

CineCam:

• CineCam2D
• CineCam3D

VirtualCam:

• VirtualCam2D
• VirtualCam3D

CamSequence:

• CamSequence2D
• CamSequence3D

Some random useful information:

• Every feature requires at least one CineCam and one VirtualCam Node of the corresponding space!
  Also at least one VirtualCam has to be higher in the SceneTree, than a CineCam, even if the VirtualCam is not being used at all!

• VirtualCam node can be found using their ID!
  If the vcam_id property has a string assigned, you can use the find_vcam_by_id() method of a CineCam,
  along with a key, to get the first found instance of a VirtualCam in the SceneTree that matches the key!

• CamSequence nodes can be used kind of like a container from a CineCam point of view!
  For example the seq_blend_next() and seq_blend_prev() methods of a CineCam can blend to the next VirtualCam of a currently assigned sequence,
  starting the sequence in the process!

• Blends and running sequences, as well as following a target can be paused!
  See the "pause", "resume", "toggle" and "stop" methods of a CineCam for this!

• A CineCam will always know about every VirtualCam of its own space (2D / 3D) in the SceneTree.
  It will also react, if their priority change, even when that only happens, because a new VirtualCam is instanced or an existing one is freed.

• A CamSequence will always know all of its VirtualCam children. The playback order of the sequence will change, if VirtualCam nodes are reorderd, instanced or freed.
  You can get an Array of VirtualCam nodes in order of playback using CamSequence get_vcam2d_array() / get_vcam3d_array() method.

• CineCam nodes, VirtualCam nodes and CamSequence nodes have some signals, which can be connected.
  CineCam for example has a signal for when a blend is complete or a sequence has started.

• After a blend has started, you can use the full_blend_duration() method to get the calculated time in seconds of the entire blend.
  Using this, you can manually blend other things along with camera blend.