CamTarget3D class reference ‐ CineCam wiki

CamTarget3D

Inherits: < Node3D < CanvasItem < Node < Object

Description

This help document refers to CamTarget3D class!
A Target for the CineCam3D.
This node is used as a "carrot on a stick" for a CineCam3D.
See CineCam3D.target and CineCam3D.FollowMode for more infos.

Links

Following a target

Inspector

Properties

Type	Property	Hint
Tween.EaseType	ease	-
Tween.TransitionType	trans	-
Vector3	offset	default: Vector3(0.0, 0.0, 0.0)
float	speed_x	default: 0.0
float	speed_y	default: 0.0
float	speed_z	default: 0.0

Methods

Return
Vector3	scaled_speed()
Tween.EaseType	get_ease()
void	set_ease(ease : Tween.EaseType)
Tween.TransitionType	get_trans()
void	set_trans(trans : Tween.TransitionType)
Vector3	get_target_offset()
void	set_target_offset(value : Vector2)
float	get_speed_x()
void	set_speed_x(value : float)
float	get_speed_y()
void	set_speed_y(value : float)
float	get_speed_z()
void	set_speed_z(value : float)

Property Description

• Tween.EaseType ease
  [SET] set_ease(value)
  [GET] get_ease()
  
  Getter / Setter for the ease type of the blend.
  See Tween.EaseType for more info.

• Tween.TransitionType trans
  [SET] set_trans(value)
  [GET] get_trans()
  
  Getter / Setter for the transition type of the blend.
  See Tween.TransitionType for more info.

• Vector2 offset
  [SET] set_target_offset(value)
  [GET] get_target_offset()
  
  Getter / Setter for the target offset.
  If a CineCam3D is following this target, it will add this offest to the equation.
  Example: Useful if you want to pan the camera upwards, when a character looks up or down, like in some platformers.

• float speed_x
  [SET] set_speed_x(value)
  [GET] get_speed_x()
  
  Getter / setter for the X-Axis follow speed.
  X-Axis blend speed, if a CineCam3D is following this target, using CineCam3D.TARGET_BLEND.
  This is set in percentage from 0.0% to 100.0%. Cannot exceed this limit!

• float speed_y
  [SET] set_speed_y(value)
  [GET] get_speed_y()
  
  Getter / setter for the vertical follow speed.
  Y-Axis blend speed, if a CineCam3D is following this target, using CineCam3D.TARGET_BLEND.
  This is set in percentage from 0.0% to 100.0%. Cannot exceed this limit!

• float speed_z
  [SET] set_speed_z(value)
  [GET] get_speed_z()
  
  Getter / setter for the Z-Axis follow speed.
  Z-Axis blend speed, if a CineCam3D is following this target, using CineCam3D.TARGET_BLEND.
  This is set in percentage from 0.0% to 100.0%. Cannot exceed this limit!

Descriptions

• Vector3 scaled_speed()
  
  Returns speed_x, speed_y and speed_z as a Vector3, but scaled down to represent the actual blending speed.
  From 0.00 to 1.00

• Tween.EaseType get_ease()
  
  Getter for ease.

• void set_ease(ease : Tween.EaseType)
  
  Setter for ease.

• Tween.TransitionType get_trans()
  
  Getter for trans.

• void set_trans(trans : Tween.TransitionType)
  
  Setter for trans.

• Vector2 get_target_offset()
  
  Getter for offset.

• void set_target_offset(value : Vector2)
  
  Setter for offset.

• float get_speed_x()
  
  Getter for speed_x.

• void set_speed_x(value : float)
  
  Setter for speed_x.

• float get_speed_y()
  
  Getter for speed_y.

• void set_speed_y(value : float)
  
  Setter for speed_y.

• float get_speed_z()
  
  Getter for speed_z.

• void set_speed_z(value : float)
  
  Setter for speed_z.