tfC_event.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of Tissue Forge.
 * Copyright (c) 2022-2024 T.J. Sego
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 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 Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 ******************************************************************************/

 
#ifndef _WRAPS_C_TFC_EVENT_H_
#define _WRAPS_C_TFC_EVENT_H_
 
#include "tf_port_c.h"
 
#include "tfCParticle.h"
 
typedef HRESULT (*tfEventEventMethodHandleFcn)(struct tfEventEventHandle*);
typedef HRESULT (*tfEventParticleEventMethodHandleFcn)(struct tfEventParticleEventHandle*);
typedef HRESULT (*tfEventTimeEventMethodHandleFcn)(struct tfEventTimeEventHandle*);
typedef HRESULT (*tfEventParticleTimeEventMethodHandleFcn)(struct tfEventParticleTimeEventHandle*);
 
// Handles
 
struct CAPI_EXPORT tfEventParticleEventParticleSelectorEnumHandle {
    unsigned int LARGEST; 
    unsigned int UNIFORM;
    unsigned int DEFAULT;
};
 
struct CAPI_EXPORT tfEventTimeEventTimeSetterEnumHandle {
    unsigned int DEFAULT;
    unsigned int DETERMINISTIC;
    unsigned int EXPONENTIAL;
};
 
struct CAPI_EXPORT tfEventParticleTimeEventParticleSelectorEnumHandle {
    unsigned int LARGEST; 
    unsigned int UNIFORM;
    unsigned int DEFAULT;
};
 
struct CAPI_EXPORT tfEventParticleTimeEventTimeSetterEnumHandle {
    unsigned int DETERMINISTIC;
    unsigned int EXPONENTIAL;
    unsigned int DEFAULT;
};

struct CAPI_EXPORT tfEventEventHandle {
    void *tfObj;
};

struct CAPI_EXPORT tfEventParticleEventHandle {
    void *tfObj;
};

struct CAPI_EXPORT tfEventTimeEventHandle {
    void *tfObj;
};

struct CAPI_EXPORT tfEventParticleTimeEventHandle {
    void *tfObj;
};
 

// event::ParticleEventParticleSelectorEnum //
 

CAPI_FUNC(HRESULT) tfEventParticleEventParticleSelectorEnum_init(struct tfEventParticleEventParticleSelectorEnumHandle *handle);
 

// event::TimeEventTimeSetterEnum //
 

CAPI_FUNC(HRESULT) tfEventTimeEventTimeSetterEnum_init(struct tfEventTimeEventTimeSetterEnumHandle *handle);
 

// event::ParticleTimeEventParticleSelectorEnum //
 

CAPI_FUNC(HRESULT) tfEventParticleTimeEventParticleSelectorEnum_init(struct tfEventParticleTimeEventParticleSelectorEnumHandle *handle);
 

// event::ParticleTimeEventTimeSetterEnum //
 

CAPI_FUNC(HRESULT) tfEventParticleTimeEventTimeSetterEnum_init(struct tfEventParticleTimeEventTimeSetterEnumHandle *handle);
 

// event::Event //
 

CAPI_FUNC(HRESULT) tfEventEvent_getLastFired(struct tfEventEventHandle *handle, tfFloatP_t *last_fired);

CAPI_FUNC(HRESULT) tfEventEvent_getTimesFired(struct tfEventEventHandle *handle, unsigned int *times_fired);

CAPI_FUNC(HRESULT) tfEventEvent_remove(struct tfEventEventHandle *handle);
 

// event::ParticleEvent //
 

CAPI_FUNC(HRESULT) tfEventParticleEvent_getLastFired(struct tfEventParticleEventHandle *handle, tfFloatP_t *last_fired);

CAPI_FUNC(HRESULT) tfEventParticleEvent_getTimesFired(struct tfEventParticleEventHandle *handle, unsigned int *times_fired);

CAPI_FUNC(HRESULT) tfEventParticleEvent_remove(struct tfEventParticleEventHandle *handle);

CAPI_FUNC(HRESULT) tfEventParticleEvent_getTargetType(struct tfEventParticleEventHandle *handle, struct tfParticleTypeHandle *targetType);

CAPI_FUNC(HRESULT) tfEventParticleEvent_getTargetParticle(struct tfEventParticleEventHandle *handle, struct tfParticleHandleHandle *targetParticle);
 

// event::TimeEvent //
 

CAPI_FUNC(HRESULT) tfEventTimeEvent_getLastFired(struct tfEventTimeEventHandle *handle, tfFloatP_t *last_fired);

CAPI_FUNC(HRESULT) tfEventTimeEvent_getTimesFired(struct tfEventTimeEventHandle *handle, unsigned int *times_fired);

CAPI_FUNC(HRESULT) tfEventTimeEvent_remove(struct tfEventTimeEventHandle *handle);

CAPI_FUNC(HRESULT) tfEventTimeEvent_getNextTime(struct tfEventTimeEventHandle *handle, tfFloatP_t *next_time);

CAPI_FUNC(HRESULT) tfEventTimeEvent_getPeriod(struct tfEventTimeEventHandle *handle, tfFloatP_t *period);

CAPI_FUNC(HRESULT) tfEventTimeEvent_getStartTime(struct tfEventTimeEventHandle *handle, tfFloatP_t *start_time);

CAPI_FUNC(HRESULT) tfEventTimeEvent_getEndTime(struct tfEventTimeEventHandle *handle, tfFloatP_t *end_time);
 

// event::ParticleTimeEvent //
 

CAPI_FUNC(HRESULT) tfEventParticleTimeEvent_getLastFired(struct tfEventParticleTimeEventHandle *handle, tfFloatP_t *last_fired);

CAPI_FUNC(HRESULT) tfEventParticleTimeEvent_getTimesFired(struct tfEventParticleTimeEventHandle *handle, unsigned int *times_fired);

CAPI_FUNC(HRESULT) tfEventParticleTimeEvent_remove(struct tfEventParticleTimeEventHandle *handle);

CAPI_FUNC(HRESULT) tfEventParticleTimeEvent_getNextTime(struct tfEventParticleTimeEventHandle *handle, tfFloatP_t *next_time);

CAPI_FUNC(HRESULT) tfEventParticleTimeEvent_getPeriod(struct tfEventParticleTimeEventHandle *handle, tfFloatP_t *period);

CAPI_FUNC(HRESULT) tfEventParticleTimeEvent_getStartTime(struct tfEventParticleTimeEventHandle *handle, tfFloatP_t *start_time);

CAPI_FUNC(HRESULT) tfEventParticleTimeEvent_getEndTime(struct tfEventParticleTimeEventHandle *handle, tfFloatP_t *end_time);

CAPI_FUNC(HRESULT) tfEventParticleTimeEvent_getTargetType(struct tfEventParticleTimeEventHandle *handle, struct tfParticleTypeHandle *targetType);

CAPI_FUNC(HRESULT) tfEventParticleTimeEvent_getTargetParticle(struct tfEventParticleTimeEventHandle *handle, struct tfParticleHandleHandle *targetParticle);
 

// Module functions //
 

CAPI_FUNC(HRESULT) tfEventOnEvent(struct tfEventEventHandle *handle, tfEventEventMethodHandleFcn *invokeMethod, tfEventEventMethodHandleFcn *predicateMethod);

CAPI_FUNC(HRESULT) tfEventOnParticleEvent(
    struct tfEventParticleEventHandle *handle, 
    struct tfParticleTypeHandle *targetType, 
    unsigned int selectorEnum, 
    tfEventParticleEventMethodHandleFcn *invokeMethod, 
    tfEventParticleEventMethodHandleFcn *predicateMethod
);

CAPI_FUNC(HRESULT) tfEventOnTimeEvent(
    struct tfEventTimeEventHandle *handle, 
    tfFloatP_t period, 
    tfEventTimeEventMethodHandleFcn *invokeMethod, 
    tfEventTimeEventMethodHandleFcn *predicateMethod, 
    unsigned int nextTimeSetterEnum, 
    tfFloatP_t start_time, 
    tfFloatP_t end_time
);

CAPI_FUNC(HRESULT) tfEventOnParticleTimeEvent(
    struct tfEventParticleTimeEventHandle *handle, 
    struct tfParticleTypeHandle *targetType, 
    tfFloatP_t period, 
    tfEventParticleTimeEventMethodHandleFcn *invokeMethod, 
    tfEventParticleTimeEventMethodHandleFcn *predicateMethod, 
    unsigned int nextTimeSetterEnum, 
    tfFloatP_t start_time, 
    tfFloatP_t end_time, 
    unsigned int particleSelectorEnum
);
 
#endif // _WRAPS_C_TFC_EVENT_H_