BKE_effect.h

Go to the documentation of this file.

/*
 * $Id: BKE_effect.h 38663 2011-07-24 17:44:22Z jhk $ 
 *
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */
#ifndef BKE_EFFECT_H
#define BKE_EFFECT_H

#include "DNA_modifier_types.h"

struct Object;
struct Scene;
struct Effect;
struct ListBase;
struct Particle;
struct Group;
struct RNG;
struct ParticleSimulationData;
struct ParticleData;
struct ParticleKey;

struct EffectorWeights *BKE_add_effector_weights(struct Group *group);
struct PartDeflect *object_add_collision_fields(int type);

/* Input to effector code */
typedef struct EffectedPoint {
        float *loc;
        float *vel;
        float *ave;     /* angular velocity for particles with dynamic rotation */
        float *rot; /* rotation quaternion for particles with dynamic rotation */
        float vel_to_frame;
        float vel_to_sec;

        /* only for particles */
        float size, charge;

        unsigned int flag;
        int index;

        struct ParticleSystem *psys;    /* particle system the point belongs to */
} EffectedPoint;

typedef struct GuideEffectorData {
        float vec_to_point[3];
        float strength;
} GuideEffectorData;

typedef struct EffectorData {
        /* Effector point */
        float loc[3];
        float nor[3];
        float vel[3];

        float vec_to_point[3];
        float distance, falloff;

        /* only for effector particles */
        float size, charge;

        /* only for vortex effector with surface falloff */
        float nor2[3], vec_to_point2[3];

        int *index;     /* point index */
} EffectorData;

/* used for calculating the effector force */
typedef struct EffectorCache {
        struct EffectorCache *next, *prev;

        struct Scene *scene;
        struct Object *ob;
        struct ParticleSystem *psys;
        struct SurfaceModifierData *surmd;
        
        struct PartDeflect *pd;

        /* precalculated for guides */
        struct GuideEffectorData *guide_data;
        float guide_loc[4], guide_dir[3], guide_radius;
        float velocity[3];

        float frame;
        int flag;
} EffectorCache;

void free_effect(struct Effect *eff);
void free_effects(struct ListBase *lb);
struct Effect *copy_effect(struct Effect *eff);
void copy_effects(struct ListBase *lbn, struct ListBase *lb);
void deselectall_eff(struct Object *ob);

struct PartEff *give_parteff(struct Object *ob);


void                    free_partdeflect(struct PartDeflect *pd);
struct ListBase *pdInitEffectors(struct Scene *scene, struct Object *ob_src, struct ParticleSystem *psys_src, struct EffectorWeights *weights);
void                    pdEndEffectors(struct ListBase **effectors);
void                    pdDoEffectors(struct ListBase *effectors, struct ListBase *colliders, struct EffectorWeights *weights, struct EffectedPoint *point, float *force, float *impulse);

void pd_point_from_particle(struct ParticleSimulationData *sim, struct ParticleData *pa, struct ParticleKey *state, struct EffectedPoint *point);
void pd_point_from_loc(struct Scene *scene, float *loc, float *vel, int index, struct EffectedPoint *point);
void pd_point_from_soft(struct Scene *scene, float *loc, float *vel, int index, struct EffectedPoint *point);

/* needed for boids */
float effector_falloff(struct EffectorCache *eff, struct EffectorData *efd, struct EffectedPoint *point, struct EffectorWeights *weights);
int closest_point_on_surface(struct SurfaceModifierData *surmd, float *co, float *surface_co, float *surface_nor, float *surface_vel);
int get_effector_data(struct EffectorCache *eff, struct EffectorData *efd, struct EffectedPoint *point, int real_velocity);

/* required for particle_system.c */
//void do_physical_effector(struct EffectorData *eff, struct EffectorPoint *point, float *total_force);
//float effector_falloff(struct EffectorData *eff, struct EffectorPoint *point, struct EffectorWeights *weights);

/* EffectedPoint->flag */
#define PE_WIND_AS_SPEED                1
#define PE_DYNAMIC_ROTATION             2
#define PE_USE_NORMAL_DATA              4

/* EffectorData->flag */
#define PE_VELOCITY_TO_IMPULSE  1


#endif