tornavis/source/blender/makesdna/DNA_scene_types.h

793 lines
19 KiB
C

/**
* $Id$
*
* ***** BEGIN GPL/BL DUAL 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. The Blender
* Foundation also sells licenses for use in proprietary software under
* the Blender License. See http://www.blender.org/BL/ for information
* about this.
*
* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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/BL DUAL LICENSE BLOCK *****
*/
#ifndef DNA_SCENE_TYPES_H
#define DNA_SCENE_TYPES_H
#ifdef __cplusplus
extern "C" {
#endif
#include "DNA_vec_types.h"
#include "DNA_listBase.h"
#include "DNA_scriptlink_types.h"
#include "DNA_ID.h"
#include "DNA_scriptlink_types.h"
struct Radio;
struct Object;
struct World;
struct Scene;
struct Image;
struct Group;
struct bNodeTree;
typedef struct Base {
struct Base *next, *prev;
unsigned int lay, selcol;
int flag;
short sx, sy;
struct Object *object;
} Base;
typedef struct AviCodecData {
void *lpFormat; /* save format */
void *lpParms; /* compressor options */
unsigned int cbFormat; /* size of lpFormat buffer */
unsigned int cbParms; /* size of lpParms buffer */
unsigned int fccType; /* stream type, for consistency */
unsigned int fccHandler; /* compressor */
unsigned int dwKeyFrameEvery; /* keyframe rate */
unsigned int dwQuality; /* compress quality 0-10,000 */
unsigned int dwBytesPerSecond; /* bytes per second */
unsigned int dwFlags; /* flags... see below */
unsigned int dwInterleaveEvery; /* for non-video streams only */
unsigned int pad;
char avicodecname[128];
} AviCodecData;
typedef struct QuicktimeCodecData {
void *cdParms; /* codec/compressor options */
void *pad; /* padding */
unsigned int cdSize; /* size of cdParms buffer */
unsigned int pad2; /* padding */
char qtcodecname[128];
} QuicktimeCodecData;
typedef struct FFMpegCodecData {
int type;
int codec;
int audio_codec;
int video_bitrate;
int audio_bitrate;
int gop_size;
int flags;
int rc_min_rate;
int rc_max_rate;
int rc_buffer_size;
int mux_packet_size;
int mux_rate;
} FFMpegCodecData;
typedef struct AudioData {
int mixrate;
float main; /* Main mix in dB */
short flag;
short pad[3];
} AudioData;
typedef struct SceneRenderLayer {
struct SceneRenderLayer *next, *prev;
char name[32];
struct Material *mat_override;
struct Group *light_override;
unsigned int lay; /* scene->lay itself has priority over this */
unsigned int lay_zmask; /* has to be after lay, this is for Z-masking */
int layflag;
int pad;
int passflag; /* pass_xor has to be after passflag */
int pass_xor;
} SceneRenderLayer;
/* srl->layflag */
#define SCE_LAY_SOLID 1
#define SCE_LAY_ZTRA 2
#define SCE_LAY_HALO 4
#define SCE_LAY_EDGE 8
#define SCE_LAY_SKY 16
#define SCE_LAY_STRAND 32
/* flags between 32 and 0x8000 are set to 1 already, for future options */
#define SCE_LAY_ALL_Z 0x8000
#define SCE_LAY_XOR 0x10000
#define SCE_LAY_DISABLE 0x20000
#define SCE_LAY_ZMASK 0x40000
/* srl->passflag */
#define SCE_PASS_COMBINED 1
#define SCE_PASS_Z 2
#define SCE_PASS_RGBA 4
#define SCE_PASS_DIFFUSE 8
#define SCE_PASS_SPEC 16
#define SCE_PASS_SHADOW 32
#define SCE_PASS_AO 64
#define SCE_PASS_REFLECT 128
#define SCE_PASS_NORMAL 256
#define SCE_PASS_VECTOR 512
#define SCE_PASS_REFRACT 1024
#define SCE_PASS_INDEXOB 2048
#define SCE_PASS_UV 4096
#define SCE_PASS_RADIO 8192
#define SCE_PASS_MIST 16384
/* note, srl->passflag is treestore element 'nr' in outliner, short still... */
typedef struct RenderData {
struct AviCodecData *avicodecdata;
struct QuicktimeCodecData *qtcodecdata;
struct FFMpegCodecData ffcodecdata;
int cfra, sfra, efra; /* frames as in 'images' */
int psfra, pefra; /* start+end frames of preview range */
int images, framapto;
short flag, threads;
float ctime; /* use for calcutions */
float framelen, blurfac;
/** For UR edge rendering: give the edges this color */
float edgeR, edgeG, edgeB;
short fullscreen, xplay, yplay, freqplay; /* standalone player */
short depth, attrib, rt1, rt2; /* standalone player */
short stereomode; /* standalone player stereo settings */
short dimensionspreset; /* for the dimensions presets menu */
short filtertype; /* filter is box, tent, gauss, mitch, etc */
short size, maximsize; /* size in %, max in Kb */
/* from buttons: */
/**
* The desired number of pixels in the x direction
*/
short xsch;
/**
* The desired number of pixels in the y direction
*/
short ysch;
/**
* Adjustment factors for the aspect ratio in the x direction
*/
short xasp;
/**
* Adjustment factors for the aspect ratio in the x direction
*/
short yasp;
/**
* The number of part to use in the x direction
*/
short xparts;
/**
* The number of part to use in the y direction
*/
short yparts;
short winpos, planes, imtype, subimtype;
/** Mode bits: */
/* 0: Enable backbuffering for images */
short bufflag;
short quality;
/**
* Flags for render settings. Use bit-masking to access the settings.
*/
short scemode;
/**
* Flags for render settings. Use bit-masking to access the settings.
*/
int mode;
/* render engine, octree resolution */
short renderer, ocres, rpad[2];
/**
* What to do with the sky/background. Picks sky/premul/key
* blending for the background
*/
short alphamode;
/**
* The number of samples to use per pixel.
*/
short osa;
short frs_sec, edgeint;
/* safety, border and display rect */
rctf safety, border;
rcti disprect;
/* information on different layers to be rendered */
ListBase layers;
short actlay, pad;
float frs_sec_base;
/**
* Value used to define filter size for all filter options */
float gauss;
/** post-production settings. Depricated, but here for upwards compat (initialized to 1) */
float postmul, postgamma, posthue, postsat;
/* Dither noise intensity */
float dither_intensity;
/* Bake Render options */
short bake_osa, bake_filter, bake_mode, bake_flag;
short bake_normal_space, bpad;
float bake_maxdist;
/* yafray: global panel params. TODO: move elsewhere */
short GIquality, GIcache, GImethod, GIphotons, GIdirect;
short YF_AA, YFexportxml, YF_nobump, YF_clamprgb, yfpad1;
int GIdepth, GIcausdepth, GIpixelspersample;
int GIphotoncount, GImixphotons;
float GIphotonradius;
int YF_numprocs, YF_raydepth, YF_AApasses, YF_AAsamples;
float GIshadowquality, GIrefinement, GIpower, GIindirpower;
float YF_gamma, YF_exposure, YF_raybias, YF_AApixelsize, YF_AAthreshold;
/* paths to backbufffer, output, ftype */
char backbuf[160], pic[160];
/* stamps flags. */
int stamp;
short stamp_font_id, pad3; /* select one of blenders bitmap fonts */
/* stamp info user data. */
char stamp_udata[160];
/* foreground/background color. */
float fg_stamp[4];
float bg_stamp[4];
} RenderData;
typedef struct GameFraming {
float col[3];
char type, pad1, pad2, pad3;
} GameFraming;
#define SCE_GAMEFRAMING_BARS 0
#define SCE_GAMEFRAMING_EXTEND 1
#define SCE_GAMEFRAMING_SCALE 2
typedef struct TimeMarker {
struct TimeMarker *next, *prev;
int frame;
char name[64];
unsigned int flag;
} TimeMarker;
typedef struct ImagePaintSettings {
struct Brush *brush;
short flag, tool;
int pad3;
} ImagePaintSettings;
typedef struct ParticleBrushData {
short size, strength; /* commong settings */
short step, invert; /* for specific brushes only */
} ParticleBrushData;
typedef struct ParticleEditSettings {
short flag;
short totrekey;
short totaddkey;
short brushtype;
ParticleBrushData brush[7]; /* 7 = PE_TOT_BRUSH */
float emitterdist;
int draw_timed;
} ParticleEditSettings;
typedef struct TransformOrientation {
struct TransformOrientation *next, *prev;
char name[36];
float mat[3][3];
} TransformOrientation;
typedef struct ToolSettings {
/* Subdivide Settings */
short cornertype;
short editbutflag;
/*Triangle to Quad conversion threshold*/
float jointrilimit;
/* Extrude Tools */
float degr;
short step;
short turn;
float extr_offs;
float doublimit;
/* Primitive Settings */
/* UV Sphere */
short segments;
short rings;
/* Cylinder - Tube - Circle */
short vertices;
/* UV Calculation */
short unwrapper;
float uvcalc_radius;
float uvcalc_cubesize;
short uvcalc_mapdir;
short uvcalc_mapalign;
short uvcalc_flag;
/* Auto-IK */
short autoik_chainlen;
/* Image Paint (8 byttse aligned please!) */
struct ImagePaintSettings imapaint;
/* Particle Editing */
struct ParticleEditSettings particle;
/* Select Group Threshold */
float select_thresh;
/* IPO-Editor */
float clean_thresh;
/* Retopo */
char retopo_mode;
char retopo_paint_tool;
char line_div, ellipse_div, retopo_hotspot;
/* Multires */
char multires_subdiv_type;
/* Skeleton generation */
short skgen_resolution;
float skgen_threshold_internal;
float skgen_threshold_external;
float skgen_length_ratio;
float skgen_length_limit;
float skgen_angle_limit;
float skgen_correlation_limit;
float skgen_symmetry_limit;
short skgen_options;
char skgen_postpro;
char skgen_postpro_passes;
char skgen_subdivisions[3];
char pad3[5];
} ToolSettings;
/* Used by all brushes to store their properties, which can be directly set
by the interface code. Note that not all properties are actually used by
all the brushes. */
typedef struct BrushData
{
short size;
char strength, dir; /* Not used for smooth brush */
char view;
char flag;
char pad[2];
} BrushData;
struct SculptSession;
typedef struct SculptData
{
/* Data stored only from entering sculptmode until exiting sculptmode */
struct SculptSession *session;
/* Pointers to all of sculptmodes's textures */
struct MTex *mtex[10];
/* Editable brush shape */
struct CurveMapping *cumap;
/* Settings for each brush */
BrushData drawbrush, smoothbrush, pinchbrush, inflatebrush, grabbrush, layerbrush, flattenbrush;
short brush_type;
/* For the Brush Shape */
short texact, texnr;
short spacing;
char texrept;
char texfade;
char texsep;
char averaging;
char flags;
/* Control tablet input */
char tablet_size, tablet_strength;
/* Symmetry is separate from the other BrushData because the same
settings are always used for all brush types */
char symm;
/* Added to store if the 'Rake' setting has been set */
char rake;
char pad[7];
} SculptData;
typedef struct Scene {
ID id;
struct Object *camera;
struct World *world;
struct Scene *set;
struct Image *ima;
ListBase base;
struct Base *basact;
float cursor[3];
float twcent[3]; /* center for transform widget */
float twmin[3], twmax[3]; /* boundbox of selection for transform widget */
unsigned int lay;
/* editmode stuff */
float editbutsize; /* size of normals */
short selectmode; /* for mesh only! */
short proportional, prop_mode;
short automerge, pad5, pad6, pad7;
short use_nodes;
struct bNodeTree *nodetree;
void *ed; /* sequence editor data is allocated here */
struct Radio *radio;
struct GameFraming framing;
struct ToolSettings *toolsettings;
/* migrate or replace? depends on some internal things... */
/* no, is on the right place (ton) */
struct RenderData r;
struct AudioData audio;
ScriptLink scriptlink;
ListBase markers;
ListBase transform_spaces;
short jumpframe, pad1;
short snap_flag, snap_target;
/* none of the dependancy graph vars is mean to be saved */
struct DagForest *theDag;
short dagisvalid, dagflags;
short pad4, recalc; /* recalc = counterpart of ob->recalc */
/* Sculptmode data */
struct SculptData sculptdata;
} Scene;
/* **************** RENDERDATA ********************* */
/* bufflag */
#define R_BACKBUF 1
#define R_BACKBUFANIM 2
#define R_FRONTBUF 4
#define R_FRONTBUFANIM 8
/* mode (int now) */
#define R_OSA 0x0001
#define R_SHADOW 0x0002
#define R_GAMMA 0x0004
#define R_ORTHO 0x0008
#define R_ENVMAP 0x0010
#define R_EDGE 0x0020
#define R_FIELDS 0x0040
#define R_FIELDSTILL 0x0080
#define R_RADIO 0x0100
#define R_BORDER 0x0200
#define R_PANORAMA 0x0400
#define R_CROP 0x0800
#define R_COSMO 0x1000
#define R_ODDFIELD 0x2000
#define R_MBLUR 0x4000
/* unified was here */
#define R_RAYTRACE 0x10000
/* R_GAUSS is obsolete, but used to retrieve setting from old files */
#define R_GAUSS 0x20000
/* fbuf obsolete... */
#define R_FBUF 0x40000
/* threads obsolete... is there for old files */
#define R_THREADS 0x80000
#define R_SPEED 0x100000
#define R_SSS 0x200000
#define R_NO_OVERWRITE 0x400000 /* skip existing files */
#define R_TOUCH 0x800000 /* touch files before rendering */
/* filtertype */
#define R_FILTER_BOX 0
#define R_FILTER_TENT 1
#define R_FILTER_QUAD 2
#define R_FILTER_CUBIC 3
#define R_FILTER_CATROM 4
#define R_FILTER_GAUSS 5
#define R_FILTER_MITCH 6
#define R_FILTER_FAST_GAUSS 7 /* note, this is only used for nodes at the moment */
/* yafray: renderer flag (not only exclusive to yafray) */
#define R_INTERN 0
#define R_YAFRAY 1
/* scemode */
#define R_DOSEQ 0x0001
#define R_BG_RENDER 0x0002
/* passepartout is camera option now, keep this for backward compatibility */
#define R_PASSEPARTOUT 0x0004
#define R_PREVIEWBUTS 0x0008
#define R_EXTENSION 0x0010
#define R_NODE_PREVIEW 0x0020
#define R_DOCOMP 0x0040
#define R_COMP_CROP 0x0080
#define R_FREE_IMAGE 0x0100
#define R_SINGLE_LAYER 0x0200
#define R_EXR_TILE_FILE 0x0400
#define R_COMP_FREE 0x0800
#define R_NO_IMAGE_LOAD 0x1000
#define R_NO_TEX 0x2000
#define R_STAMP_INFO 0x4000
#define R_FULL_SAMPLE 0x8000
/* r->stamp */
#define R_STAMP_TIME 0x0001
#define R_STAMP_FRAME 0x0002
#define R_STAMP_DATE 0x0004
#define R_STAMP_CAMERA 0x0008
#define R_STAMP_SCENE 0x0010
#define R_STAMP_NOTE 0x0020
#define R_STAMP_DRAW 0x0040 /* draw in the image */
#define R_STAMP_MARKER 0x0080
#define R_STAMP_FILENAME 0x0100
#define R_STAMP_SEQSTRIP 0x0200
/* alphamode */
#define R_ADDSKY 0
#define R_ALPHAPREMUL 1
#define R_ALPHAKEY 2
/* planes */
#define R_PLANES24 24
#define R_PLANES32 32
#define R_PLANESBW 8
/* imtype */
#define R_TARGA 0
#define R_IRIS 1
#define R_HAMX 2
#define R_FTYPE 3 /* ftype is nomore */
#define R_JPEG90 4
#define R_MOVIE 5
#define R_IRIZ 7
#define R_RAWTGA 14
#define R_AVIRAW 15
#define R_AVIJPEG 16
#define R_PNG 17
#define R_AVICODEC 18
#define R_QUICKTIME 19
#define R_BMP 20
#define R_RADHDR 21
#define R_TIFF 22
#define R_OPENEXR 23
#define R_FFMPEG 24
#define R_FRAMESERVER 25
#define R_CINEON 26
#define R_DPX 27
#define R_MULTILAYER 28
#define R_DDS 29
/* subimtype, flag options for imtype */
#define R_OPENEXR_HALF 1
#define R_OPENEXR_ZBUF 2
#define R_PREVIEW_JPG 4
/* bake_mode: same as RE_BAKE_xxx defines */
/* bake_flag: */
#define R_BAKE_CLEAR 1
#define R_BAKE_OSA 2
#define R_BAKE_TO_ACTIVE 4
/* bake_normal_space */
#define R_BAKE_SPACE_CAMERA 0
#define R_BAKE_SPACE_WORLD 1
#define R_BAKE_SPACE_OBJECT 2
#define R_BAKE_SPACE_TANGENT 3
/* **************** SCENE ********************* */
#define RAD_PHASE_PATCHES 1
#define RAD_PHASE_FACES 2
/* base->flag is in DNA_object_types.h */
/* scene->snap_flag */
#define SCE_SNAP 1
/* scene->snap_target */
#define SCE_SNAP_TARGET_CLOSEST 0
#define SCE_SNAP_TARGET_CENTER 1
#define SCE_SNAP_TARGET_MEDIAN 2
#define SCE_SNAP_TARGET_ACTIVE 3
/* sce->selectmode */
#define SCE_SELECT_VERTEX 1 /* for mesh */
#define SCE_SELECT_EDGE 2
#define SCE_SELECT_FACE 4
/* sce->selectmode for particles */
#define SCE_SELECT_PATH 1
#define SCE_SELECT_POINT 2
#define SCE_SELECT_END 4
/* sce->recalc (now in use by previewrender) */
#define SCE_PRV_CHANGED 1
/* sce->prop_mode (proportional falloff) */
#define PROP_SMOOTH 0
#define PROP_SPHERE 1
#define PROP_ROOT 2
#define PROP_SHARP 3
#define PROP_LIN 4
#define PROP_CONST 5
#define PROP_RANDOM 6
/* return flag next_object function */
#define F_START 0
#define F_SCENE 1
#define F_SET 2
#define F_DUPLI 3
/* audio->flag */
#define AUDIO_MUTE 1
#define AUDIO_SYNC 2
#define AUDIO_SCRUB 4
#define FFMPEG_MULTIPLEX_AUDIO 1
#define FFMPEG_AUTOSPLIT_OUTPUT 2
/* Sculpt brush flags */
#define SCULPT_BRUSH_AIRBRUSH 1
#define SCULPT_BRUSH_ANCHORED 2
/* SculptData.flags */
#define SCULPT_INPUT_SMOOTH 1
#define SCULPT_DRAW_FAST 2
#define SCULPT_DRAW_BRUSH 4
/* SculptData.brushtype */
#define DRAW_BRUSH 1
#define SMOOTH_BRUSH 2
#define PINCH_BRUSH 3
#define INFLATE_BRUSH 4
#define GRAB_BRUSH 5
#define LAYER_BRUSH 6
#define FLATTEN_BRUSH 7
/* SculptData.texrept */
#define SCULPTREPT_DRAG 1
#define SCULPTREPT_TILE 2
#define SCULPTREPT_3D 3
#define SYMM_X 1
#define SYMM_Y 2
#define SYMM_Z 4
/* toolsettings->imagepaint_flag */
#define IMAGEPAINT_DRAWING 1
#define IMAGEPAINT_DRAW_TOOL 2
#define IMAGEPAINT_DRAW_TOOL_DRAWING 4
/* toolsettings->particle flag */
#define PE_KEEP_LENGTHS 1
#define PE_LOCK_FIRST 2
#define PE_DEFLECT_EMITTER 4
#define PE_INTERPOLATE_ADDED 8
#define PE_SHOW_CHILD 16
#define PE_SHOW_TIME 32
#define PE_X_MIRROR 64
/* toolsetting->particle brushtype */
#define PE_BRUSH_NONE -1
#define PE_BRUSH_COMB 0
#define PE_BRUSH_CUT 1
#define PE_BRUSH_LENGTH 2
#define PE_BRUSH_PUFF 3
#define PE_BRUSH_ADD 4
#define PE_BRUSH_WEIGHT 5
#define PE_BRUSH_SMOOTH 6
/* this must equal ParticleEditSettings.brush array size */
#define PE_TOT_BRUSH 7
/* toolsettings->retopo_mode */
#define RETOPO 1
#define RETOPO_PAINT 2
/* toolsettings->retopo_paint_tool */
#define RETOPO_PEN 1
#define RETOPO_LINE 2
#define RETOPO_ELLIPSE 4
/* toolsettings->skgen_options */
#define SKGEN_FILTER_INTERNAL 1
#define SKGEN_FILTER_EXTERNAL 2
#define SKGEN_SYMMETRY 4
#define SKGEN_CUT_LENGTH 8
#define SKGEN_CUT_ANGLE 16
#define SKGEN_CUT_CORRELATION 32
#define SKGEN_SUB_LENGTH 0
#define SKGEN_SUB_ANGLE 1
#define SKGEN_SUB_CORRELATION 2
#define SKGEN_SUB_TOTAL 3
/* toolsettings->skgen_postpro */
#define SKGEN_SMOOTH 0
#define SKGEN_AVERAGE 1
#define SKGEN_SHARPEN 2
#ifdef __cplusplus
}
#endif
#endif