boids.cc File Reference

#include <cmath>
#include <cstring>
#include "MEM_guardedalloc.h"
#include "DNA_object_force_types.h"
#include "DNA_scene_types.h"
#include "BLI_blenlib.h"
#include "BLI_kdtree.h"
#include "BLI_math_base_safe.h"
#include "BLI_math_rotation.h"
#include "BLI_math_vector.h"
#include "BLI_rand.h"
#include "BLI_utildefines.h"
#include "BKE_boids.h"
#include "BKE_collision.h"
#include "BKE_effect.h"
#include "BKE_particle.h"
#include "BLI_kdopbvh.h"
#include "BLT_translation.hh"
#include "BKE_modifier.hh"
#include "RNA_enum_types.hh"

Go to the source code of this file.

Classes
struct	BoidValues

Typedefs
using	boid_rule_cb

Functions
static float	len_squared_v3v3_with_normal_bias (const float co_search[3], const float co_test[3], const void *user_data)
static bool	apply_boid_rule (BoidBrainData *bbd, BoidRule *rule, BoidValues *val, ParticleData *pa, float fuzziness)
static bool	rule_none (BoidRule *, BoidBrainData *, BoidValues *, ParticleData *)
static bool	rule_goal_avoid (BoidRule *rule, BoidBrainData *bbd, BoidValues *val, ParticleData *pa)
static bool	rule_avoid_collision (BoidRule *rule, BoidBrainData *bbd, BoidValues *val, ParticleData *pa)
static bool	rule_separate (BoidRule *, BoidBrainData *bbd, BoidValues *val, ParticleData *pa)
static bool	rule_flock (BoidRule *, BoidBrainData *bbd, BoidValues *, ParticleData *pa)
static bool	rule_follow_leader (BoidRule *rule, BoidBrainData *bbd, BoidValues *val, ParticleData *pa)
static bool	rule_average_speed (BoidRule *rule, BoidBrainData *bbd, BoidValues *val, ParticleData *pa)
static bool	rule_fight (BoidRule *rule, BoidBrainData *bbd, BoidValues *val, ParticleData *pa)
static void	set_boid_values (BoidValues *val, BoidSettings *boids, ParticleData *pa)
static Object *	boid_find_ground (BoidBrainData *bbd, ParticleData *pa, float ground_co[3], float ground_nor[3])
static bool	boid_rule_applies (ParticleData *pa, BoidSettings *, BoidRule *rule)
void	boids_precalc_rules (ParticleSettings *part, float cfra)
static void	boid_climb (BoidSettings *boids, ParticleData *pa, float *surface_co, float *surface_nor)
static float	boid_goal_signed_dist (float *boid_co, float *goal_co, float *goal_nor)
static BoidState *	get_boid_state (BoidSettings *boids, ParticleData *pa)
void	boid_brain (BoidBrainData *bbd, int p, ParticleData *pa)
void	boid_body (BoidBrainData *bbd, ParticleData *pa)
BoidRule *	boid_new_rule (int type)
void	boid_default_settings (BoidSettings *boids)
BoidState *	boid_new_state (BoidSettings *boids)
BoidState *	boid_duplicate_state (BoidSettings *boids, BoidState *state)
void	boid_free_settings (BoidSettings *boids)
BoidSettings *	boid_copy_settings (const BoidSettings *boids)
BoidState *	boid_get_current_state (BoidSettings *boids)

Variables
static boid_rule_cb	boid_rules []

Typedef Documentation

boid_rule_cb

using boid_rule_cb

Initial value:

 bool (*)(BoidRule *rule,
                              BoidBrainData *data,
                              BoidValues *val,
                              ParticleData *pa)

Definition at line 783 of file boids.cc.

Function Documentation

apply_boid_rule()

static bool apply_boid_rule ( BoidBrainData * bbd, BoidRule * rule, BoidValues * val, ParticleData * pa, float fuzziness )

static

Definition at line 1002 of file boids.cc.

References boid_rule_applies(), boid_rules, ParticleSettings::boids, compare_len_v3v3(), len_v3(), BoidBrainData::part, ParticleData::prev_state, BoidRule::type, ParticleKey::vel, and BoidBrainData::wanted_co.

Referenced by boid_brain().

boid_body()

void boid_body	(	BoidBrainData *	bbd,
		struct ParticleData *	pa )

Tries to realize the wanted velocity taking all constraints into account.

Definition at line 1209 of file boids.cc.

References BoidData::acc, add_v3_v3(), add_v3_v3v3(), angle(), ParticleKey::ave, axis_angle_to_quat(), BoidSettings::banking, BKE_effectors_apply(), BLI_rng_get_float(), ParticleData::boid, BOID_ALLOW_FLIGHT, BOID_ALLOW_LAND, boid_climb(), boid_find_ground(), boid_goal_signed_dist(), ParticleSettings::boids, ParticleKey::co, ParticleSimulationData::colliders, copy_particle_key(), copy_qt_qt(), copy_v2_v2(), copy_v3_v3(), cross_v3_v3v3(), ParticleSettings::dampfac, BoidParticle::data, BoidBrainData::dfra, dot_v2v2(), dot_v3v3(), eBoidMode_Climbing, eBoidMode_Falling, eBoidMode_InAir, eBoidMode_Liftoff, eBoidMode_OnLand, ParticleSettings::effector_weights, ParticleSystem::effectors, ELEM, ParticleSettings::flag, BoidBrainData::goal_co, BoidBrainData::goal_nor, BoidBrainData::goal_ob, BoidParticle::gravity, PhysicsSettings::gravity, BoidParticle::ground, BoidSettings::height, BoidSettings::land_stick_force, BoidSettings::landing_smoothness, len_v3(), madd_v3_v3fl(), madd_v3_v3v3fl(), ParticleSettings::mass, mat3_to_quat_legacy(), BoidValues::max_acc, BoidValues::max_ave, BoidValues::max_speed, min_ff(), BoidValues::min_speed, BoidData::mode, mul_qt_v3(), mul_v2_fl(), mul_v3_fl(), negate_v3(), negate_v3_v3(), nor, normalize_v2(), normalize_v3(), normalize_v3_v3(), BoidSettings::options, BoidBrainData::part, PART_SIZEMASS, pd_point_from_particle(), Scene::physics_settings, BoidSettings::pitch, ParticleData::prev_state, project_v3_v3v3(), ParticleSimulationData::psys, psys_uses_gravity(), BoidBrainData::rng, ParticleKey::rot, safe_acosf(), safe_sqrtf(), ParticleSimulationData::scene, set_boid_values(), BoidBrainData::sim, ParticleData::size, ParticleData::state, sub_v3_v3v3(), BoidBrainData::timestep, v, ParticleKey::vel, BoidBrainData::wanted_co, and BoidBrainData::wanted_speed.

Referenced by dynamics_step().

boid_brain()

void boid_brain	(	BoidBrainData *	bbd,
		int	p,
		struct ParticleData *	pa )

Determines the velocity the boid wants to have.

Definition at line 1052 of file boids.cc.

References add_v2_v2v2(), add_v3_v3(), ParticleData::alive, apply_boid_rule(), ParticleKey::ave, BLI_findlink(), BLI_listbase_count(), ParticleData::boid, BOID_ALLOW_FLIGHT, ParticleSettings::boids, BoidBrainData::cfra, copy_v3_v3(), BoidParticle::data, ParticleData::dietime, dot_v2v2(), eBoidMode_Falling, eBoidMode_Liftoff, eBoidMode_OnLand, eBoidRulesetType_Average, eBoidRulesetType_Fuzzy, eBoidRulesetType_Random, float, get_boid_state(), PhysicsSettings::gravity, BoidData::health, int, jump(), BoidValues::jump_speed, len, len_v2(), LISTBASE_FOREACH, BoidValues::max_speed, BoidData::mode, mul(), mul_v3_fl(), normalize_v2(), normalize_v3(), BoidSettings::options, PARS_DYING, BoidBrainData::part, Scene::physics_settings, ParticleData::prev_state, ParticleSimulationData::psys, psys_frand(), safe_sqrtf(), ParticleSimulationData::scene, ParticleSystem::seed, set_boid_values(), BoidBrainData::sim, state, ParticleKey::vel, BoidBrainData::wanted_co, BoidBrainData::wanted_speed, and zero_v3().

Referenced by dynamics_step().

boid_climb()

static void boid_climb ( BoidSettings * boids, ParticleData * pa, float * surface_co, float * surface_nor )

static

Definition at line 972 of file boids.cc.

References add_v3_v3v3(), ParticleData::boid, ParticleKey::co, copy_v3_v3(), BoidParticle::gravity, BoidSettings::height, madd_v3_v3fl(), mul_v3_fl(), nor, normalize_v3(), project_v3_v3v3(), ParticleData::size, ParticleData::state, sub_v3_v3v3(), and ParticleKey::vel.

Referenced by boid_body().

boid_copy_settings()

BoidSettings * boid_copy_settings

(

const BoidSettings *

boids

)

Definition at line 1699 of file boids.cc.

References BoidState::actions, BLI_duplicatelist(), BoidState::conditions, ListBase::first, MEM_dupallocN, BoidState::next, BoidState::rules, state, and BoidSettings::states.

boid_default_settings()

void boid_default_settings

(

BoidSettings *

boids

)

Definition at line 1626 of file boids.cc.

References BoidSettings::accuracy, BoidSettings::aggression, BoidSettings::air_max_acc, BoidSettings::air_max_ave, BoidSettings::air_max_speed, BoidSettings::air_personal_space, BoidSettings::banking, BOID_ALLOW_FLIGHT, BoidSettings::health, BoidSettings::height, BoidSettings::land_max_acc, BoidSettings::land_max_ave, BoidSettings::land_max_speed, BoidSettings::land_personal_space, BoidSettings::landing_smoothness, BoidSettings::options, BoidSettings::pitch, BoidSettings::range, and BoidSettings::strength.

boid_duplicate_state()

BoidState * boid_duplicate_state	(	BoidSettings *	boids,
		BoidState *	state )

Definition at line 1671 of file boids.cc.

References BoidState::actions, BLI_duplicatelist(), BoidState::conditions, BoidState::id, BoidSettings::last_state_id, MEM_dupallocN, BoidState::rules, and state.

boid_find_ground()

static Object * boid_find_ground ( BoidBrainData * bbd, ParticleData * pa, float ground_co[3], float ground_nor[3] )

static

Definition at line 829 of file boids.cc.

References add_v3_v3(), add_v3_v3v3(), BKE_modifiers_findby_type(), BKE_psys_collision_neartest_cb(), BLI_bvhtree_ray_cast_ex(), ParticleData::boid, BVH_RAYCAST_DEFAULT, closest_point_on_surface(), ParticleKey::co, col, ParticleSimulationData::colliders, copy_v3_v3(), BoidParticle::data, eBoidMode_Climbing, eModifierType_Surface, BoidParticle::ground, interp_v3_v3v3(), LISTBASE_FOREACH, BoidData::mode, normalize_v3(), normalize_v3_v3(), BoidBrainData::sim, ParticleData::state, sub_v3_v3(), sub_v3_v3v3(), and v.

Referenced by boid_body().

boid_free_settings()

void boid_free_settings

(

BoidSettings *

boids

)

Definition at line 1683 of file boids.cc.

References BLI_freelistN(), ListBase::first, MEM_freeN(), state, and BoidSettings::states.

Referenced by particle_settings_free_data().

boid_get_current_state()

BoidState * boid_get_current_state

(

BoidSettings *

boids

)

Definition at line 1722 of file boids.cc.

References BOIDSTATE_CURRENT, ListBase::first, state, and BoidSettings::states.

Referenced by rule_add_exec(), rule_del_exec(), rule_move_down_exec(), and rule_move_up_exec().

boid_goal_signed_dist()

static float boid_goal_signed_dist ( float * boid_co, float * goal_co, float * goal_nor )

static

Definition at line 993 of file boids.cc.

References dot_v3v3(), and sub_v3_v3v3().

Referenced by boid_body().

boid_new_rule()

BoidRule * boid_new_rule

(

int

type

)

Definition at line 1583 of file boids.cc.

References BOIDRULE_IN_AIR, BOIDRULE_ON_LAND, DATA_, eBoidRuleType_AverageSpeed, eBoidRuleType_Avoid, eBoidRuleType_AvoidCollision, eBoidRuleType_Fight, eBoidRuleType_FollowLeader, eBoidRuleType_Goal, BoidRule::flag, MEM_callocN, BoidRule::name, rna_enum_boidrule_type_items, STRNCPY_UTF8, and BoidRule::type.

Referenced by rule_add_exec().

boid_new_state()

BoidState * boid_new_state

(

BoidSettings *

boids

)

Definition at line 1652 of file boids.cc.

References BoidState::id, BoidSettings::last_state_id, MEM_callocN, SNPRINTF, state, and STRNCPY.

Referenced by state_add_exec(), and state_del_exec().

boid_rule_applies()

static bool boid_rule_applies ( ParticleData * pa, BoidSettings * , BoidRule * rule )

static

Definition at line 936 of file boids.cc.

References ParticleData::boid, BOIDRULE_IN_AIR, BOIDRULE_ON_LAND, BoidParticle::data, eBoidMode_Climbing, eBoidMode_InAir, eBoidMode_OnLand, ELEM, BoidRule::flag, and BoidData::mode.

Referenced by apply_boid_rule().

boids_precalc_rules()

void boids_precalc_rules	(	ParticleSettings *	part,
		float	cfra )

Definition at line 955 of file boids.cc.

References BoidRuleFollowLeader::cfra, copy_v3_v3(), eBoidRuleType_FollowLeader, LISTBASE_FOREACH, BoidRuleFollowLeader::loc, BoidRuleFollowLeader::ob, BoidRuleFollowLeader::oloc, state, and BoidRule::type.

Referenced by dynamics_step().

get_boid_state()

static BoidState * get_boid_state ( BoidSettings * boids, ParticleData * pa )

static

Definition at line 1025 of file boids.cc.

References ParticleData::boid, BoidParticle::data, ListBase::first, state, BoidData::state_id, and BoidSettings::states.

Referenced by boid_brain().

len_squared_v3v3_with_normal_bias()

static float len_squared_v3v3_with_normal_bias ( const float co_search[3], const float co_test[3], const void * user_data )

static

Definition at line 37 of file boids.cc.

References dot_v3v3(), len_squared_v3(), and sub_v3_v3v3().

Referenced by rule_avoid_collision(), and rule_flock().

rule_average_speed()

static bool rule_average_speed ( BoidRule * rule, BoidBrainData * bbd, BoidValues * val, ParticleData * pa )

static

Definition at line 623 of file boids.cc.

References add_v3_v3(), ParticleKey::ave, BLI_rng_get_float(), ParticleData::boid, copy_v3_v3(), dot_v2v2(), PhysicsSettings::gravity, BoidRuleAverageSpeed::level, BoidValues::max_speed, mul_qt_v3(), mul_v3_fl(), normalize_v3(), Scene::physics_settings, ParticleData::prev_state, project_v3_v3v3(), psys_uses_gravity(), BoidBrainData::rng, ParticleKey::rot, ParticleSimulationData::scene, BoidBrainData::sim, BoidRuleAverageSpeed::speed, sub_v3_v3(), BoidParticle::wander, BoidRuleAverageSpeed::wander, BoidBrainData::wanted_co, and BoidBrainData::wanted_speed.

rule_avoid_collision()

static bool rule_avoid_collision ( BoidRule * rule, BoidBrainData * bbd, BoidValues * val, ParticleData * pa )

static

Definition at line 208 of file boids.cc.

References add_v3_v3v3(), ParticleKey::ave, BKE_psys_collision_neartest_cb(), BLI_assert, BLI_bvhtree_ray_cast_ex(), BLI_rng_get_float(), ParticleData::boid, BRULE_ACOLL_WITH_BOIDS, BRULE_ACOLL_WITH_DEFLECTORS, BVH_RAYCAST_DEFAULT, ParticleKey::co, col, ParticleSimulationData::colliders, copy_v3_v3(), dot_v3v3(), BoidParticle::ground, len, len_squared_v3v3_with_normal_bias(), len_v3(), LISTBASE_FOREACH, BoidRuleAvoidCollision::look_ahead, madd_v3_v3fl(), MEM_freeN(), MEM_SAFE_FREE, BoidValues::min_speed, mul_v3_fl(), normalize_v3(), ParticleSimulationData::ob, BoidRuleAvoidCollision::options, ParticleSystem::particles, BoidValues::personal_space, ParticleData::prev_state, ParticleSimulationData::psys, psys_get_target_system(), ret, BoidBrainData::rng, BoidBrainData::sim, ParticleData::size, sqrtf, sub_v3_v3v3(), ParticleSystem::targets, ParticleSystem::tree, ParticleKey::vel, BoidBrainData::wanted_co, and BoidBrainData::wanted_speed.

rule_fight()

static bool rule_fight ( BoidRule * rule, BoidBrainData * bbd, BoidValues * val, ParticleData * pa )

static

Definition at line 678 of file boids.cc.

References BoidSettings::accuracy, BoidSettings::aggression, ParticleKey::ave, BLI_rng_get_float(), ParticleData::boid, ParticleSettings::boids, ParticleKey::co, copy_v3_v3(), BoidParticle::data, BoidRuleFight::distance, dot_v3v3(), BoidData::health, BoidSettings::health, LISTBASE_FOREACH, BoidValues::max_speed, MEM_SAFE_FREE, negate_v3(), normalize_v3_v3(), ParticleSimulationData::ob, BoidBrainData::part, ParticleSystem::part, ParticleSystem::particles, ParticleData::prev_state, ParticleSimulationData::psys, psys_get_target_system(), PTARGET_MODE_ENEMY, PTARGET_MODE_FRIEND, ret, BoidBrainData::rng, BoidBrainData::sim, ParticleData::size, BoidSettings::strength, sub_v3_v3v3(), ParticleSystem::targets, BoidBrainData::timestep, ParticleSystem::tree, BoidBrainData::wanted_co, and BoidBrainData::wanted_speed.

rule_flock()

static bool rule_flock ( BoidRule * , BoidBrainData * bbd, BoidValues * , ParticleData * pa )

static

Definition at line 444 of file boids.cc.

References add_v3_v3(), ARRAY_SIZE, ParticleKey::ave, ParticleKey::co, len_squared_v3v3_with_normal_bias(), len_v3(), mul_v3_fl(), ParticleSystem::particles, ParticleData::prev_state, ParticleSimulationData::psys, ret, BoidBrainData::sim, ParticleData::state, sub_v3_v3(), ParticleSystem::tree, ParticleKey::vel, BoidBrainData::wanted_co, and BoidBrainData::wanted_speed.

rule_follow_leader()

static bool rule_follow_leader ( BoidRule * rule, BoidBrainData * bbd, BoidValues * val, ParticleData * pa )

static

Definition at line 481 of file boids.cc.

References ARRAY_HAS_ITEM, BLI_assert, BRULE_LEADER_IN_LINE, ParticleKey::co, copy_v3_v3(), BoidRuleFollowLeader::distance, dot_v3v3(), int, len, len_v3(), BoidRuleFollowLeader::loc, madd_v3_v3fl(), BoidValues::max_speed, mul(), mul_v3_fl(), BoidRuleFollowLeader::ob, BoidRuleFollowLeader::oloc, BoidRuleFollowLeader::options, ParticleSystem::particles, ParticleData::prev_state, ParticleSimulationData::psys, BoidRuleFollowLeader::queue_size, ret, BoidBrainData::sim, ParticleData::size, sub_v3_v3v3(), BoidBrainData::timestep, ParticleSystem::totpart, ParticleKey::vel, BoidBrainData::wanted_co, and BoidBrainData::wanted_speed.

rule_goal_avoid()

static bool rule_goal_avoid ( BoidRule * rule, BoidBrainData * bbd, BoidValues * val, ParticleData * pa )

static

Definition at line 72 of file boids.cc.

References add_v3_v3(), ParticleData::boid, BOID_ALLOW_CLIMB, ParticleSettings::boids, BRULE_GOAL_AVOID_PREDICT, ParticleKey::co, copy_v3_v3(), BoidParticle::data, EffectorCache::depsgraph, ParticleSimulationData::depsgraph, EffectorData::distance, eBoidMode_Climbing, eBoidRuleType_Avoid, eBoidRuleType_Goal, effector_falloff(), ParticleSettings::effector_weights, ParticleSystem::effectors, PartDeflect::f_strength, BoidRuleGoalAvoid::fear_factor, PartDeflect::forcefield, get_effector_data(), BoidBrainData::goal_co, BoidBrainData::goal_nor, BoidBrainData::goal_ob, BoidBrainData::goal_priority, BoidParticle::gravity, BoidParticle::ground, BoidSettings::height, EffectorData::index, BoidSettings::landing_smoothness, len, len_v3(), LISTBASE_FOREACH, EffectorData::loc, BoidValues::max_speed, BoidData::mode, mul(), mul_v3_fl(), negate_v3_v3(), EffectorData::nor, BoidRuleGoalAvoid::ob, EffectorCache::ob, BoidRuleGoalAvoid::options, BoidSettings::options, BoidBrainData::part, EffectorCache::pd, pd_point_from_particle(), PFIELD_BOID, PFIELD_SHAPE_SURFACE, powf, ParticleData::prev_state, ParticleSimulationData::psys, ret, EffectorCache::scene, ParticleSimulationData::scene, PartDeflect::shape, BoidBrainData::sim, ParticleData::size, ParticleData::state, sub_v3_v3v3(), BoidBrainData::timestep, BoidRule::type, EffectorData::vec_to_point, EffectorData::vel, ParticleKey::vel, BoidBrainData::wanted_co, and BoidBrainData::wanted_speed.

rule_none()

static bool rule_none ( BoidRule * , BoidBrainData * , BoidValues * , ParticleData *  )

static

Definition at line 64 of file boids.cc.

rule_separate()

static bool rule_separate ( BoidRule * , BoidBrainData * bbd, BoidValues * val, ParticleData * pa )

static

Definition at line 400 of file boids.cc.

References add_v3_v3(), ParticleKey::co, len, LISTBASE_FOREACH, BoidValues::max_speed, MEM_SAFE_FREE, mul_v3_fl(), ParticleSimulationData::ob, ParticleSystem::particles, BoidValues::personal_space, ParticleData::prev_state, ParticleSimulationData::psys, psys_get_target_system(), ret, BoidBrainData::sim, ParticleData::size, ParticleData::state, sub_v3_v3v3(), ParticleSystem::targets, ParticleSystem::tree, BoidBrainData::wanted_co, and BoidBrainData::wanted_speed.

set_boid_values()

static void set_boid_values ( BoidValues * val, BoidSettings * boids, ParticleData * pa )

static

Definition at line 807 of file boids.cc.

References BoidSettings::air_max_acc, BoidSettings::air_max_ave, BoidSettings::air_max_speed, BoidSettings::air_min_speed, BoidSettings::air_personal_space, ParticleData::boid, BoidParticle::data, eBoidMode_Climbing, eBoidMode_OnLand, ELEM, float, BoidData::health, BoidSettings::health, BoidValues::jump_speed, BoidSettings::land_jump_speed, BoidSettings::land_max_acc, BoidSettings::land_max_ave, BoidSettings::land_max_speed, BoidSettings::land_personal_space, M_PI, BoidValues::max_acc, BoidValues::max_ave, BoidValues::max_speed, BoidValues::min_speed, BoidData::mode, and BoidValues::personal_space.

Referenced by boid_body(), and boid_brain().

Variable Documentation

boid_rules

boid_rule_cb boid_rules[]

static

Initial value:

= {
    rule_none,
    rule_goal_avoid,
    rule_goal_avoid,
    rule_avoid_collision,
    rule_separate,
    rule_flock,
    rule_follow_leader,
    rule_average_speed,
    rule_fight,
 
 
 
 
 
 
 
}

Definition at line 788 of file boids.cc.

Referenced by apply_boid_rule().