CineCam3D class reference ‐ CineCam wiki
This help document refers to CineCam3D class!
Main Camera for the CineCam3D.
Features include camera shaking, camera blending to VirtualCam3D, targeting CamTarget3D and more.
Inspector
| Type | Property | Hint |
|---|---|---|
| BlendData3D | blend_data | - |
| bool | blend_pause | default: false |
| CamSequence3D | current_sequence | - |
| FollowMode | follow_mode | default: 0 |
| bool | follow_prio_pause | default: false |
| bool | follow_target_pause | - |
| CamSequence3D | look_at_target | default: false |
| bool | sequence_pause | default: false |
| float | shake_offset_duration | default: 0.0 |
| Vector3 | shake_offset_intensity | default: Vector3(0, 0, 0) |
| float | shake_rotation_duration | default: 0.0 |
| float | shake_rotation_intensity | default: 0.0 |
| float | shake_fov_duration | default: 0.0 |
| Vector3 | shake_fov_intensity | default: Vector3(0, 0, 0) |
| CamTarget3D | target | - |
- signal blend_completed()
Emitted when a blend is completed.
Will not be emitted for CineCam3D.FollowMode CineCam3D.TARGET_BLEND.
- signal blend_paused()
Emitted when a blend is paused.
Will not be emitted for CineCam3D.FollowMode CineCam3D.TARGET_BLEND.
- signal blend_resumed()
Emitted when a blend is resumed.
Will not be emitted for CineCam3D.FollowMode CineCam3D.TARGET_BLEND.
- signal blend_started()
Emitted when a blend is completed.
Will not be emitted for CineCam3D.FollowMode CineCam3D.TARGET_BLEND.
- signal prioritized_vcam3D_changed(vcam3D: Object, priority: int)
Emitted when any registered VirtualCam3D priority became higher than the previously highest priority VirtualCam3D.
Returns the VirtualCam3D with the now highest priority as an integer.
See VirtualCam3D.priority.
It doesn't matter, if this CineCam3D acts on it.
- signal sequence_completed()
Emitted when a sequence of blends, using CamSequence3D was completed.
- signal sequence_paused()
Emitted when a sequence of blends, using CamSequence3D was paused.
See CineCam3D.seq_pause
- signal sequence_resumed()
Emitted when a sequence of blends, using CamSequence3D was resumed.
See CineCam3D.seq_resume
- signal sequence_started()
Emitted when a sequence of blends, using CamSequence3D was started. See:
' CineCam3D.start_sequence
' CineCam3D.start_sequence_at
' CineCam3D.seq_blend_to
' CineCam3D.seq_blend_prev
' CineCam3D.seq_blend_next
- signal sequence_stopped()
Emitted when a sequence of blends, using CamSequence3D was stopped.
See CineCam3D.seq_stop
- signal shake_offset_ended()
Emitted when the camera shake, using its offset, has ended.
See CineCam3D.shake_offset
- signal shake_offset_started()
Emitted when the camera shake, using its offset, is started.
See CineCam3D.shake_offset
- signal shake_rotation_ended()
Emitted when the camera shake, using its rotation, has ended.
See CineCam3D.shake_rotation
- signal shake_rotation_started()
Emitted when the camera shake, using its rotation, has started.
See CineCam3D.shake_rotation
- signal shake_fov_ended()
Emitted when the camera shake, using its fov, has ended.
See CineCam3D.shake_fov
- signal shake_fov_started()
Emitted when the camera shake, using its fov, has started.
See CineCam3D.shake_fov
- enum FollowMode:
Setings for CineCam3D.follow_mode.
PRIO refers to the VirtualCam3D with the highest priority in the [SceneTree] only!
TARGET is for CamTarget3D if it is set in CineCam3D.target!
' OFF = 0,
Won't Follow anything.
' PRIO = 1,
Will constantly follow the it.
' PRIO_ONESHOT = 2,
Will follow it once.
' PRIO_BLEND = 3,
Will blend towards it once, using the data from VirtualCam3D.blend_data.
If none are given, CineCam3D.blend_data will be used.
' TARGET = 4,
Will constantly follow the target.
' TARGET_BLEND = 5
Will constantly blend towards the target.
- BlendData3D blend_data
[SET] _set_blend_data(value)
[GET] _get_blend_data()
The default blending data for this CineCam3D.
Only used as default value for blending to VirtualCam3D and only if it has no BlendData3D set.
- bool blend_pause
[SET] _set_blend_paused(value)
[GET] _is_blend_paused()
Getter / Setter for pausing the tween that is used for camera blends.
See CineCam3D.pause_blend.
- CamSequence3D current_sequence
[SET] set_current_sequence(value)
[GET] get_current_sequence()
Getter / Setter for the current CamSequence3D.
- FollowMode follow_mode
[SET] set_follow_mode(value)
[GET] get_follow_mode()
Getter / Setter for the current follow mode property.
See CineCam3D.FollowMode
- bool follow_prio_pause
[SET] set_follow_prio_paused(value)
[GET] is_follow_prio_paused()
- bool follow_target_pause
[SET] set_follow_target_paused(value)
[GET] is_follow_target_paused()
Getter / Setter for pausing the follow target feature.
See CineCam3D.TARGET, CineCam3D.TARGET_BLEND and CineCam3D.pause_follow_target.
- bool sequence_pause
[SET] _set_seq_paused(value)
[GET] _is_seq_paused()
Getter / Setter for pausing the camera sequence feature.
See CamSequence3D and CineCam3D.start_sequence.
- float shake_offset_duration
[SET] _set_shake_offset_duration(value)
[GET] _get_shake_offset_duration()
Getter / Setter for the shake offset duration.
Can be increased during a shake to increase its duration.
- Vector3 shake_offset_intensity
[SET] _set_shake_offset_intensity(value)
[GET] _get_shake_offset_intensity()
Getter / Setter for the shake offset intensity.
Can be increased during a shake to increase its intensity.
- float shake_rotation_duration
[SET] _set_shake_rotation_duration(value)
[GET] _get_shake_rotation_duration()
Getter / Setter for the shake rotation duration.
Can be increased during a shake to increase its duration.
- float shake_rotation_intensity
[SET] _set_shake_rotation_intensity(value)
[GET] _get_shake_rotation_intensity()
Getter / Setter for the shake rotation intensity.
Can be increased during a shake to increase its intensity.
- float shake_fov_duration
[SET] _set_shake_fov_duration(value)
[GET] _get_shake_fov_duration()
Getter / Setter for the shake fov duration.
Can be increased during a shake to increase its duration.
- Vector3 shake_fov_intensity
[SET] _set_shake_fov_intensity(value)
[GET] _get_shake_fov_intensity()
Getter / Setter for the shake fov intensity.
Can be increased during a shake to increase its intensity.
- CamTarget3D target
[SET] set_target(value)
[GET] get_target()
Getter / Setter for the current CamTarget3D.
- String apply_vcam3D_data(vcam3D: VirtualCam3D)
Applies all data from the given VirtualCam3D under Camera3D Section to this CineCam3D.
- void blend_to(vcam3D : VirtualCam3D, blend_data : BlendData3D)
Blends towards the given VirtualCam3D, using the given BlendData3D.
You can use CineCam3D.blend_data, VirtualCam3D.blend_data or data from any other source.
- VirtualCam3D find_vcam_by_id(id : String)
Returns the first VirtualCam3D with the given id.
Will only search registered VirtualCam3D.
See VirtualCam3D.vcam_id.
- float full_blend_duration()
Returns the full duration of the current blend.
This is either BlendData3D.blend_by_value if BlendData3D.blend_by is set to BlendData3D.DURATION
or a calculated duration, if set to BlendData3D.SPEED.
Will return -1 if the blend has not started yet.
- void init_default_blend_data()
Sets CineCam3D.blend_data to the default data.
- void pause_blend()
This will pause the currently running blend.
Will only affect CineCam3D.blend_to, CineCam3D.PRIO_BLEND or anything from CamSequence3D.
- void pause_follow_prio()
This will pause the follow priority feature.
See CineCam3D.FollowMode CineCam3D.PRIO.
- void pause_follow_target()
This will pause the follow target and target blend feature.
See CineCam3D.FollowMode CineCam3D.TARGET and CineCam3D.TARGET_BLEND.
- void prioritized_vcam()
Returns the prioritized VirtualCam3D.
- void reposition_to_vcam(vcam : VirtualCam3D)
Will teleport this Camera instantly to the given VirtualCam3D.
- void resume_blend()
Resumes the currently running blend, regardless of the current state.
Will only affect CineCam3D.blend_to, CineCam3D.PRIO_BLEND or anything from CamSequence3D.
- void resume_follow_prio()
Resumes the currently running priority blend, regardless of the current state.
See CineCam3D.FollowMode, CineCam3D.PRIO.
- void resume_follow_target()
Resumes the currently running target follow, regardless of the current state.
See CineCam3D.FollowMode, CineCam3D.TARGET and CineCam3D.TARGET_BLEND.
- void seq_blend_next()
Blends to the next VirtualCam3D in the current CineCam3D.current_sequence.
- void seq_blend_prev()
Blends to the previous VirtualCam3D in the current CineCam3D.current_sequence.
- void seq_blend_to(idx: int)
Blends to the VirtualCam3D at the given index, in the current CineCam3D.current_sequence.
- void seq_pause()
Pauses the current running sequence. Will not pause the blend, just the execution of the sequence.
- void seq_resume()
Resumes the current running sequence, regardless of the current state.
- void seq_stop()
Stops the current running sequence and resets its CamSequence3D.current_idx.
- void shake_offset(intensity : Vector3, duration : float, ease : Tween.EaseType, trans : Tween.TransitionType)
Shakes the cam.
Takes a strength and a duration in seconds.
- void shake_rotation(intensity : float, duration : float, ease : Tween.EaseType, trans : Tween.TransitionType)
Shakes the cam.
Takes a strength and a duration in seconds.
- void shake_fov(intensity : Vector3, duration : float, ease : Tween.EaseType, trans : Tween.TransitionType)
Shakes the cam fov.
Takes a strength and a duration in seconds.
- void start_sequence(backwards : bool = false)
Starts the sequence in CineCam3D.current_sequence.
You can set the optional bool to true, to play the sequence in reverse.
- void start_sequence_at(backwards : bool = false, index : int = 0)
Starts the sequence in CineCam3D.current_sequence at the given index.
You can set the optional bool to true, to play the sequence in reverse.
- void toggle_follow_prio()
Toggles the currently running priority blend, considering its current state.
See CineCam3D.FollowMode, CineCam3D.PRIO.
- void toggle_follow_target()
Toggles the currently running target follow, considering its current state.
See CineCam3D.FollowMode, CineCam3D.TARGET and CineCam3D.TARGET_BLEND.
- CamSequence3D get_current_sequence()
Getter for current_sequence.
- void set_current_sequence(value : CamSequence3D)
Setter for current_sequence.
- FollowMode get_follow_mode()
Getter for follow_mode.
- void set_follow_mode(value : FollowMode)
Setter for follow_mode.
- bool is_follow_prio_paused()
Getter for follow_prio_paused.
- void set_follow_prio_paused(value : bool)
Setter for follow_prio_paused.
- bool is_follow_target_paused()
Getter for follow_target_paused.
- void set_follow_target_paused(value : bool)
Setter for follow_target_paused.
- CamTarget3D get_target()
Getter for target.
- void set_target(value : CamTarget3D)
Setter for target.
- CamTarget3D get_look_at_target()
Getter for look_at_target.
- void set_look_at_target(value : CamTarget3D)
Setter for look_at_target.