Blender: PTCacheID Struct Reference

Blender V5.0

#include <BKE_pointcache.h>

Public Attributes
struct PTCacheID *	next
struct PTCacheID *	prev
struct Scene *	scene
struct ID *	owner_id
void *	calldata
unsigned int	type
unsigned int	file_type
unsigned int	stack_index
unsigned int	flag
unsigned int	default_step
unsigned int	max_step
unsigned int	data_types
unsigned int	info_types
int(*	write_point )(int index, void calldata, void *data, int cfra)
void(*	read_point )(int index, void calldata, void data, float cfra, const float old_data)
void(*	interpolate_point )(int index, void calldata, void data, float cfra, float cfra1, float cfra2, const float old_data)
int(*	write_stream )(PTCacheFile pf, void calldata)
int(*	read_stream )(PTCacheFile pf, void calldata)
void(*	write_extra_data )(void calldata, struct PTCacheMem pm, int cfra)
void(*	read_extra_data )(void calldata, struct PTCacheMem pm, float cfra)
void(*	interpolate_extra_data )(void calldata, struct PTCacheMem pm, float cfra, float cfra1, float cfra2)
int(*	totpoint )(void *calldata, int cfra)
void(*	error )(const struct ID owner_id, void calldata, const char *message)
int(*	totwrite )(void *calldata, int cfra)
int(*	write_header )(PTCacheFile *pf)
int(*	read_header )(PTCacheFile *pf)
struct PointCache *	cache
struct PointCache **	cache_ptr
struct ListBase *	ptcaches

Detailed Description

Definition at line 108 of file BKE_pointcache.h.

Member Data Documentation

◆ cache

struct PointCache* PTCacheID::cache

Definition at line 163 of file BKE_pointcache.h.

Referenced by BKE_ptcache_bake(), BKE_ptcache_disk_cache_rename(), BKE_ptcache_disk_to_mem(), BKE_ptcache_id_clear(), BKE_ptcache_id_exist(), BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_smoke(), BKE_ptcache_id_from_softbody(), BKE_ptcache_id_reset(), BKE_ptcache_id_time(), BKE_ptcache_load_external(), BKE_ptcache_mem_to_disk(), BKE_ptcache_object_reset(), BKE_ptcache_read(), BKE_ptcache_toggle_disk_cache(), BKE_ptcache_update_info(), BKE_ptcache_write(), cloth_clear_cache(), dynamicPaint_frameUpdate(), pe_get_current(), ptcache_add_new_exec(), ptcache_file_open(), ptcache_filepath(), ptcache_filepath_ext_append(), ptcache_find_frames_around(), ptcache_interpolate(), ptcache_path(), ptcache_read(), ptcache_remove_exec(), ptcache_write(), ptcache_write_needed(), timeline_cache_draw_single(), tot_particles(), undoptcache_from_editcache(), and undoptcache_to_editcache().

◆ cache_ptr

struct PointCache** PTCacheID::cache_ptr

Used for setting the current cache from ptcaches list.

Definition at line 165 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_smoke(), BKE_ptcache_id_from_softbody(), ptcache_add_new_exec(), and ptcache_remove_exec().

◆ calldata

void* PTCacheID::calldata

Definition at line 113 of file BKE_pointcache.h.

Referenced by BKE_ptcache_bake(), BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_smoke(), BKE_ptcache_id_from_softbody(), BKE_ptcache_id_reset(), BKE_ptcache_read(), BKE_ptcache_update_info(), BKE_ptcache_write(), pe_get_current(), ptcache_interpolate(), ptcache_read(), ptcache_read_stream(), ptcache_write(), and ptcache_write_stream().

◆ data_types

unsigned int PTCacheID::data_types

flags defined in DNA_object_force_types.h.

Definition at line 122 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), BKE_ptcache_write(), object_lib_override_apply_post(), ptcache_interpolate(), ptcache_read(), ptcache_write(), and ptcache_write_stream().

◆ default_step

unsigned int PTCacheID::default_step

Definition at line 118 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), object_lib_override_apply_post(), and ptcache_add_new_exec().

◆ error

void(* PTCacheID::error) (const struct ID *owner_id, void *calldata, const char *message)

Report error if number of points does not match

Definition at line 156 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), ptcache_interpolate(), ptcache_read(), and ptcache_read_stream().

◆ file_type

unsigned int PTCacheID::file_type

Definition at line 114 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), object_lib_override_apply_post(), and ptcache_file_extension().

◆ flag

unsigned int PTCacheID::flag

Definition at line 116 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_particles(), and update_velocities().

◆ info_types

unsigned int PTCacheID::info_types

Definition at line 122 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), BKE_ptcache_write(), object_lib_override_apply_post(), and ptcache_write().

◆ interpolate_extra_data

void(* PTCacheID::interpolate_extra_data) (void *calldata, struct PTCacheMem *pm, float cfra, float cfra1, float cfra2)

Copies custom PTCacheMem::extradata to cache data

Definition at line 147 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), and ptcache_interpolate().

◆ interpolate_point

void(* PTCacheID::interpolate_point) (int index, void *calldata, void **data, float cfra, float cfra1, float cfra2, const float *old_data)

Interpolated between previously read point data and cache data.

Definition at line 129 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), BKE_ptcache_read(), and ptcache_interpolate().

◆ max_step

unsigned int PTCacheID::max_step

Definition at line 119 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), and object_lib_override_apply_post().

◆ next

struct PTCacheID* PTCacheID::next

Definition at line 109 of file BKE_pointcache.h.

Referenced by BKE_ptcache_bake(), object_lib_override_apply_post(), and pe_get_current().

◆ owner_id

struct ID* PTCacheID::owner_id

Definition at line 112 of file BKE_pointcache.h.

Referenced by BKE_ptcache_bake(), BKE_ptcache_id_clear(), BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_smoke(), BKE_ptcache_id_from_softbody(), BKE_ptcache_toggle_disk_cache(), ptcache_file_open(), ptcache_filepath(), ptcache_filepath_ext_append(), ptcache_interpolate(), ptcache_job_endjob(), ptcache_path(), ptcache_read(), and ptcache_read_stream().

◆ prev

struct PTCacheID * PTCacheID::prev

Definition at line 109 of file BKE_pointcache.h.

◆ ptcaches

struct ListBase* PTCacheID::ptcaches

Definition at line 166 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_smoke(), BKE_ptcache_id_from_softbody(), object_lib_override_apply_post(), ptcache_add_new_exec(), ptcache_remove_exec(), and scene_lib_override_apply_post().

◆ read_extra_data

void(* PTCacheID::read_extra_data) (void *calldata, struct PTCacheMem *pm, float cfra)

Copies custom PTCacheMem::extradata to cache data.

Definition at line 145 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), and ptcache_read().

◆ read_header

int(* PTCacheID::read_header) (PTCacheFile *pf)

Definition at line 161 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), BKE_ptcache_load_external(), ptcache_disk_frame_to_mem(), and ptcache_read_stream().

◆ read_point

void(* PTCacheID::read_point) (int index, void *calldata, void **data, float cfra, const float *old_data)

Copies cache data to point data.

Definition at line 127 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), BKE_ptcache_read(), and ptcache_read().

◆ read_stream

int(* PTCacheID::read_stream) (PTCacheFile *pf, void *calldata)

Copies cache data to point data.

Definition at line 140 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), BKE_ptcache_read(), and ptcache_read_stream().

◆ scene

struct Scene* PTCacheID::scene

Definition at line 111 of file BKE_pointcache.h.

◆ stack_index

unsigned int PTCacheID::stack_index

Definition at line 115 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_smoke(), BKE_ptcache_id_from_softbody(), and ptcache_filepath_ext_append().

◆ totpoint

int(* PTCacheID::totpoint) (void *calldata, int cfra)

Total number of simulated points (the cfra parameter is just for using same function pointer with totwrite).

Definition at line 154 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), BKE_ptcache_read(), BKE_ptcache_update_info(), BKE_ptcache_write(), ptcache_interpolate(), ptcache_read(), ptcache_read_stream(), and ptcache_write().

◆ totwrite

int(* PTCacheID::totwrite) (void *calldata, int cfra)

Number of points written for current cache frame.

Definition at line 158 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), and ptcache_write().

◆ type

◆ write_extra_data

void(* PTCacheID::write_extra_data) (void *calldata, struct PTCacheMem *pm, int cfra)

Copies custom PTCacheMem::extradata to cache data.

Definition at line 143 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), and ptcache_write().

◆ write_header

int(* PTCacheID::write_header) (PTCacheFile *pf)

Definition at line 160 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), ptcache_mem_frame_to_disk(), and ptcache_write_stream().

◆ write_point

int(* PTCacheID::write_point) (int index, void *calldata, void **data, int cfra)

Copies point data to cache data.

Definition at line 125 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), BKE_ptcache_write(), and ptcache_write().

◆ write_stream

int(* PTCacheID::write_stream) (PTCacheFile *pf, void *calldata)

Copies point data to cache data.

Definition at line 138 of file BKE_pointcache.h.

Referenced by BKE_ptcache_id_from_cloth(), BKE_ptcache_id_from_dynamicpaint(), BKE_ptcache_id_from_particles(), BKE_ptcache_id_from_rigidbody(), BKE_ptcache_id_from_softbody(), BKE_ptcache_write(), and ptcache_write_stream().

The documentation for this struct was generated from the following file:

BKE_pointcache.h