godot::PixelpartVectorField Class Reference

Force field that accelerates particles in the direction of a predefined grid of vectors. More...

Inheritance diagram for godot::PixelpartVectorField:

Public Member Functions
void	set_vector_filter (int filter)
	Set how velocity values are interpolated between the cells of the vector field.
int	get_vector_filter () const
	How velocity values are interpolated between the cells of the vector field.
Ref< PixelpartAnimatedPropertyFloat >	get_tightness () const
	How directly particles follow the vectors in the force field.
Public Member Functions inherited from godot::PixelpartForceField
void	set_infinite (bool mode)
	Set whether the force field has an infinite area of effect.
bool	is_infinite () const
	Whether the force field has an infinite area of effect.
Ref< PixelpartAnimatedPropertyFloat >	get_strength () const
	How strongly particles are affected by the force field.
Public Member Functions inherited from godot::PixelpartNode
int	get_id () const
	ID of the node.
int	get_parent_id () const
	ID of the node's parent.
String	get_name () const
	Name of the node.
void	set_lifetime_start (float time)
	Set time until the node becomes active.
void	set_lifetime_duration (float time)
	Set how long the node stays active in seconds.
void	set_repeat (bool value)
	Set whether the node repeats its behavior after its lifetime is over.
float	get_lifetime_start () const
	Time in seconds until the node becomes active.
float	get_lifetime_duration () const
	How long the node is active in seconds.
bool	get_repeat () const
	Wether the node repeats its behavior after its lifetime is over.
bool	is_active () const
	Return whether the node is active at the current point in time.
float	get_local_time () const
	Return the time fraction the emitter has been active for, in range 0.0 (0%) to 1.0 (100%).
Ref< PixelpartAnimatedPropertyFloat3 >	get_position () const
	Position of the node.
Ref< PixelpartAnimatedPropertyFloat3 >	get_rotation () const
	Rotation of the node in degrees.
Ref< PixelpartAnimatedPropertyFloat3 >	get_scale () const
	Size of the node.

Public Attributes
int	vector_filter
	How velocity values are interpolated between the cells of the vector field.
Public Attributes inherited from godot::PixelpartForceField
bool	infinite
	Whether the force field has an infinite area of effect.
Public Attributes inherited from godot::PixelpartNode
float	lifetime_start
	Time in seconds until the node becomes active.
float	lifetime_duration
	How long the node stays active in seconds.
bool	repeat
	Wether the node repeats its behavior after its lifetime is over.

Detailed Description

Force field that accelerates particles in the direction of a predefined grid of vectors.

A particle in the field follows the vector specified in the vector field at that location.

Member Function Documentation

get_tightness()

Ref< PixelpartAnimatedPropertyFloat > godot::PixelpartVectorField::get_tightness

(

)

const

How directly particles follow the vectors in the force field.

If set to 0, the field applies forces to the particles over time. If set to 1, particles follow the vectors in the force field directly.

Returns

Tightness property

get_vector_filter()

int godot::PixelpartVectorField::get_vector_filter

(

)

const

How velocity values are interpolated between the cells of the vector field.

Returns

Filtering algorithm used

set_vector_filter()

void godot::PixelpartVectorField::set_vector_filter

(

int

filter

)

Set how velocity values are interpolated between the cells of the vector field.

Parameters

filter

Filtering algorithm to use

---

The documentation for this class was generated from the following files:

• src/node/PixelpartVectorField.h
• src/node/PixelpartVectorField.cpp