VoxelData(bpy_struct)

base class — bpy_struct

class bpy.types.VoxelData(bpy_struct)

Voxel data settings

domain_object

Object used as the smoke simulation domain

Type:Object
extension

How the texture is extrapolated past its original bounds

  • EXTEND Extend, Extend by repeating edge pixels of the image.
  • CLIP Clip, Clip to image size and set exterior pixels as transparent.
  • REPEAT Repeat, Cause the image to repeat horizontally and vertically.
Type:enum in [‘EXTEND’, ‘CLIP’, ‘REPEAT’], default ‘EXTEND’
file_format

Format of the source data set to render

  • BLENDER_VOXEL Blender Voxel, Default binary voxel file format.
  • RAW_8BIT 8 bit RAW, 8 bit grayscale binary data.
  • IMAGE_SEQUENCE Image Sequence, Generate voxels from a sequence of image slices.
  • SMOKE Smoke, Render voxels from a Blender smoke simulation.
  • HAIR Hair, Render voxels from a Blender hair simulation.
Type:enum in [‘BLENDER_VOXEL’, ‘RAW_8BIT’, ‘IMAGE_SEQUENCE’, ‘SMOKE’, ‘HAIR’], default ‘BLENDER_VOXEL’
filepath

The external source data file to use

Type:string, default “”, (never None)
hair_data_type

Simulation value to be used as a texture

  • HAIRDENSITY Density, Use hair density as texture data.
  • HAIRRESTDENSITY Rest Density, Use hair rest density as texture data.
  • HAIRVELOCITY Velocity, Use hair velocity as texture data.
  • HAIRENERGY Energy, Use potential hair energy as texture data.
Type:enum in [‘HAIRDENSITY’, ‘HAIRRESTDENSITY’, ‘HAIRVELOCITY’, ‘HAIRENERGY’], default ‘HAIRDENSITY’
intensity

Multiplier for intensity values

Type:float in [0.01, inf], default 0.0
interpolation

Method to interpolate/smooth values between voxel cells

  • NEREASTNEIGHBOR Nearest Neighbor, No interpolation, fast but blocky and low quality.
  • TRILINEAR Linear, Good smoothness and speed.
  • QUADRATIC Quadratic, Mid-range quality and speed.
  • TRICUBIC_CATROM Cubic Catmull-Rom, High quality interpolation, but slower.
  • TRICUBIC_BSPLINE Cubic B-Spline, Smoothed high quality interpolation, but slower.
Type:enum in [‘NEREASTNEIGHBOR’, ‘TRILINEAR’, ‘QUADRATIC’, ‘TRICUBIC_CATROM’, ‘TRICUBIC_BSPLINE’], default ‘NEREASTNEIGHBOR’
resolution

Resolution of the voxel grid

Type:int array of 3 items in [1, 100000], default (0, 0, 0)
smoke_data_type

Simulation value to be used as a texture

  • SMOKEDENSITY Smoke, Use smoke density and color as texture data.
  • SMOKEFLAME Flame, Use flame temperature as texture data.
  • SMOKEHEAT Heat, Use smoke heat as texture data. Values from -2.0 to 2.0 are used.
  • SMOKEVEL Velocity, Use smoke velocity as texture data.
Type:enum in [‘SMOKEDENSITY’, ‘SMOKEFLAME’, ‘SMOKEHEAT’, ‘SMOKEVEL’], default ‘SMOKEDENSITY’
still_frame

The frame number to always use

Type:int in [-300000, 300000], default 0
use_still_frame

Always render a still frame from the voxel data sequence

Type:boolean, default False

Inherited Properties

Inherited Functions

References