Class ParticleData


  • public class ParticleData
    extends CFacade
    Generated facet for DNA struct type 'ParticleData'.

    Class Documentation

    • Field Detail

      • __DNA__SDNA_INDEX

        public static final int __DNA__SDNA_INDEX
        This is the sdna index of the struct ParticleData.

        It is required when allocating a new block to store data for ParticleData.

        See Also:
        StructDNA, BlockTable, Constant Field Values
      • __DNA__FIELD__state

        public static final long[] __DNA__FIELD__state
        Field descriptor (offset) for struct member 'state'.

        Field Documentation

        Blender Source Code

        Current global coordinates.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__state);
         CPointer<ParticleKey> p_state = p.cast(new Class[]{ParticleKey.class});
         

        Metadata

        • Field: 'state'
        • Signature: 'ParticleKey'
        • Actual Size (32bit/64bit): 56/56
      • __DNA__FIELD__prev_state

        public static final long[] __DNA__FIELD__prev_state
        Field descriptor (offset) for struct member 'prev_state'.

        Field Documentation

        Blender Source Code

        Previous state.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__prev_state);
         CPointer<ParticleKey> p_prev_state = p.cast(new Class[]{ParticleKey.class});
         

        Metadata

        • Field: 'prev_state'
        • Signature: 'ParticleKey'
        • Actual Size (32bit/64bit): 56/56
      • __DNA__FIELD__hair

        public static final long[] __DNA__FIELD__hair
        Field descriptor (offset) for struct member 'hair'.

        Field Documentation

        Blender Source Code

        Hair vertices.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__hair);
         CPointer<CPointer<HairKey>> p_hair = p.cast(new Class[]{CPointer.class, HairKey.class});
         

        Metadata

        • Field: 'hair'
        • Signature: 'HairKey*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__keys

        public static final long[] __DNA__FIELD__keys
        Field descriptor (offset) for struct member 'keys'.

        Field Documentation

        Blender Source Code

        Keyed keys.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__keys);
         CPointer<CPointer<ParticleKey>> p_keys = p.cast(new Class[]{CPointer.class, ParticleKey.class});
         

        Metadata

        • Field: 'keys'
        • Signature: 'ParticleKey*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__boid

        public static final long[] __DNA__FIELD__boid
        Field descriptor (offset) for struct member 'boid'.

        Field Documentation

        Blender Source Code

        Boids data.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__boid);
         CPointer<CPointer<BoidParticle>> p_boid = p.cast(new Class[]{CPointer.class, BoidParticle.class});
         

        Metadata

        • Field: 'boid'
        • Signature: 'BoidParticle*'
        • Actual Size (32bit/64bit): 4/8
      • __DNA__FIELD__totkey

        public static final long[] __DNA__FIELD__totkey
        Field descriptor (offset) for struct member 'totkey'.

        Field Documentation

        Blender Source Code

        Amount of hair or keyed keys.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__totkey);
         CPointer<Integer> p_totkey = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'totkey'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__time

        public static final long[] __DNA__FIELD__time
        Field descriptor (offset) for struct member 'time'.

        Field Documentation

        Blender Source Code

        Die-time is not necessarily time+lifetime as.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__time);
         CPointer<Float> p_time = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'time'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__lifetime

        public static final long[] __DNA__FIELD__lifetime
        Field descriptor (offset) for struct member 'lifetime'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__lifetime);
         CPointer<Float> p_lifetime = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'lifetime'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__dietime

        public static final long[] __DNA__FIELD__dietime
        Field descriptor (offset) for struct member 'dietime'.

        Field Documentation

        Blender Source Code

        Particles can die unnaturally (collision).

        Note

        Particles die on this frame, be sure to add 1 when clamping the lifetime of particles to inclusive ranges such as the scenes end frame. See: T68290.

        Particles die on this frame, be sure to add 1 when clamping the lifetime of particles to inclusive ranges such as the scenes end frame. See: T68290.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__dietime);
         CPointer<Float> p_dietime = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'dietime'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__num

        public static final long[] __DNA__FIELD__num
        Field descriptor (offset) for struct member 'num'.

        Field Documentation

        Blender Source Code

        WARNING! Those two indices, when not affected to vertices, are for !!! TESSELLATED FACES !!!, not POLYGONS! Index to vert/edge/face.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__num);
         CPointer<Integer> p_num = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'num'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__num_dmcache

        public static final long[] __DNA__FIELD__num_dmcache
        Field descriptor (offset) for struct member 'num_dmcache'.

        Field Documentation

        Blender Source Code

        Index to derived mesh data (face) to avoid slow lookups. It can also have negative values DMCACHE_NOTFOUND and DMCACHE_ISCHILD.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__num_dmcache);
         CPointer<Integer> p_num_dmcache = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'num_dmcache'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__fuv

        public static final long[] __DNA__FIELD__fuv
        Field descriptor (offset) for struct member 'fuv'.

        Field Documentation

        Blender Source Code

        Coordinates on face/edge number "num" and depth along.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__fuv);
         CPointer<CArrayFacade<Float>> p_fuv = p.cast(new Class[]{CArrayFacade.class, Float.class});
         

        Metadata

        • Field: 'fuv'
        • Signature: 'float[4]'
        • Actual Size (32bit/64bit): 16/16
      • __DNA__FIELD__foffset

        public static final long[] __DNA__FIELD__foffset
        Field descriptor (offset) for struct member 'foffset'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__foffset);
         CPointer<Float> p_foffset = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'foffset'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__size

        public static final long[] __DNA__FIELD__size
        Field descriptor (offset) for struct member 'size'.

        Field Documentation

        Blender Source Code

        face normal for volume emission. Size and multiplier so that we can update size when ever.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__size);
         CPointer<Float> p_size = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'size'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__sphdensity

        public static final long[] __DNA__FIELD__sphdensity
        Field descriptor (offset) for struct member 'sphdensity'.

        Field Documentation

        Blender Source Code

        Density of sph particle.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__sphdensity);
         CPointer<Float> p_sphdensity = p.cast(new Class[]{Float.class});
         

        Metadata

        • Field: 'sphdensity'
        • Signature: 'float'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD___pad

        public static final long[] __DNA__FIELD___pad
        Field descriptor (offset) for struct member '_pad'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD___pad);
         CPointer<CArrayFacade<Byte>> p__pad = p.cast(new Class[]{CArrayFacade.class, Byte.class});
         

        Metadata

        • Field: '_pad'
        • Signature: 'char[4]'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__hair_index

        public static final long[] __DNA__FIELD__hair_index
        Field descriptor (offset) for struct member 'hair_index'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__hair_index);
         CPointer<Integer> p_hair_index = p.cast(new Class[]{Integer.class});
         

        Metadata

        • Field: 'hair_index'
        • Signature: 'int'
        • Actual Size (32bit/64bit): 4/4
      • __DNA__FIELD__flag

        public static final long[] __DNA__FIELD__flag
        Field descriptor (offset) for struct member 'flag'.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__flag);
         CPointer<Short> p_flag = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'flag'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
      • __DNA__FIELD__alive

        public static final long[] __DNA__FIELD__alive
        Field descriptor (offset) for struct member 'alive'.

        Field Documentation

        Blender Source Code

        The life state of a particle.

        Pointer Arithmetics

        This is how you get a reference on the corresponding field in the struct:

         ParticleData particledata = ...;
         CPointer<Object> p = particledata.__dna__addressof(ParticleData.__DNA__FIELD__alive);
         CPointer<Short> p_alive = p.cast(new Class[]{Short.class});
         

        Metadata

        • Field: 'alive'
        • Signature: 'short'
        • Actual Size (32bit/64bit): 2/2
    • Constructor Detail

      • ParticleData

        public ParticleData​(long __address,
                            Block __block,
                            BlockTable __blockTable)
      • ParticleData

        protected ParticleData​(ParticleData that)
    • Method Detail

      • getState

        public ParticleKey getState()
                             throws java.io.IOException
        Get method for struct member 'state'.

        Field Documentation

        Blender Source Code

        Current global coordinates.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__state
      • setState

        public void setState​(ParticleKey state)
                      throws java.io.IOException
        Set method for struct member 'state'.

        Field Documentation

        Blender Source Code

        Current global coordinates.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__state
      • getPrev_state

        public ParticleKey getPrev_state()
                                  throws java.io.IOException
        Get method for struct member 'prev_state'.

        Field Documentation

        Blender Source Code

        Previous state.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__prev_state
      • setPrev_state

        public void setPrev_state​(ParticleKey prev_state)
                           throws java.io.IOException
        Set method for struct member 'prev_state'.

        Field Documentation

        Blender Source Code

        Previous state.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__prev_state
      • getHair

        public CPointer<HairKey> getHair()
                                  throws java.io.IOException
        Get method for struct member 'hair'.

        Field Documentation

        Blender Source Code

        Hair vertices.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__hair
      • setHair

        public void setHair​(CPointer<HairKey> hair)
                     throws java.io.IOException
        Set method for struct member 'hair'.

        Field Documentation

        Blender Source Code

        Hair vertices.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__hair
      • getKeys

        public CPointer<ParticleKey> getKeys()
                                      throws java.io.IOException
        Get method for struct member 'keys'.

        Field Documentation

        Blender Source Code

        Keyed keys.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__keys
      • setKeys

        public void setKeys​(CPointer<ParticleKey> keys)
                     throws java.io.IOException
        Set method for struct member 'keys'.

        Field Documentation

        Blender Source Code

        Keyed keys.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__keys
      • getBoid

        public CPointer<BoidParticle> getBoid()
                                       throws java.io.IOException
        Get method for struct member 'boid'.

        Field Documentation

        Blender Source Code

        Boids data.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__boid
      • setBoid

        public void setBoid​(CPointer<BoidParticle> boid)
                     throws java.io.IOException
        Set method for struct member 'boid'.

        Field Documentation

        Blender Source Code

        Boids data.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__boid
      • getTotkey

        public int getTotkey()
                      throws java.io.IOException
        Get method for struct member 'totkey'.

        Field Documentation

        Blender Source Code

        Amount of hair or keyed keys.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__totkey
      • setTotkey

        public void setTotkey​(int totkey)
                       throws java.io.IOException
        Set method for struct member 'totkey'.

        Field Documentation

        Blender Source Code

        Amount of hair or keyed keys.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__totkey
      • getTime

        public float getTime()
                      throws java.io.IOException
        Get method for struct member 'time'.

        Field Documentation

        Blender Source Code

        Die-time is not necessarily time+lifetime as.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__time
      • setTime

        public void setTime​(float time)
                     throws java.io.IOException
        Set method for struct member 'time'.

        Field Documentation

        Blender Source Code

        Die-time is not necessarily time+lifetime as.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__time
      • getLifetime

        public float getLifetime()
                          throws java.io.IOException
        Get method for struct member 'lifetime'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__lifetime
      • setLifetime

        public void setLifetime​(float lifetime)
                         throws java.io.IOException
        Set method for struct member 'lifetime'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__lifetime
      • getDietime

        public float getDietime()
                         throws java.io.IOException
        Get method for struct member 'dietime'.

        Field Documentation

        Blender Source Code

        Particles can die unnaturally (collision).

        Note

        Particles die on this frame, be sure to add 1 when clamping the lifetime of particles to inclusive ranges such as the scenes end frame. See: T68290.

        Particles die on this frame, be sure to add 1 when clamping the lifetime of particles to inclusive ranges such as the scenes end frame. See: T68290.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__dietime
      • setDietime

        public void setDietime​(float dietime)
                        throws java.io.IOException
        Set method for struct member 'dietime'.

        Field Documentation

        Blender Source Code

        Particles can die unnaturally (collision).

        Note

        Particles die on this frame, be sure to add 1 when clamping the lifetime of particles to inclusive ranges such as the scenes end frame. See: T68290.

        Particles die on this frame, be sure to add 1 when clamping the lifetime of particles to inclusive ranges such as the scenes end frame. See: T68290.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__dietime
      • getNum

        public int getNum()
                   throws java.io.IOException
        Get method for struct member 'num'.

        Field Documentation

        Blender Source Code

        WARNING! Those two indices, when not affected to vertices, are for !!! TESSELLATED FACES !!!, not POLYGONS! Index to vert/edge/face.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__num
      • setNum

        public void setNum​(int num)
                    throws java.io.IOException
        Set method for struct member 'num'.

        Field Documentation

        Blender Source Code

        WARNING! Those two indices, when not affected to vertices, are for !!! TESSELLATED FACES !!!, not POLYGONS! Index to vert/edge/face.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__num
      • getNum_dmcache

        public int getNum_dmcache()
                           throws java.io.IOException
        Get method for struct member 'num_dmcache'.

        Field Documentation

        Blender Source Code

        Index to derived mesh data (face) to avoid slow lookups. It can also have negative values DMCACHE_NOTFOUND and DMCACHE_ISCHILD.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__num_dmcache
      • setNum_dmcache

        public void setNum_dmcache​(int num_dmcache)
                            throws java.io.IOException
        Set method for struct member 'num_dmcache'.

        Field Documentation

        Blender Source Code

        Index to derived mesh data (face) to avoid slow lookups. It can also have negative values DMCACHE_NOTFOUND and DMCACHE_ISCHILD.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__num_dmcache
      • getFuv

        public CArrayFacade<java.lang.Float> getFuv()
                                             throws java.io.IOException
        Get method for struct member 'fuv'.

        Field Documentation

        Blender Source Code

        Coordinates on face/edge number "num" and depth along.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__fuv
      • setFuv

        public void setFuv​(CArrayFacade<java.lang.Float> fuv)
                    throws java.io.IOException
        Set method for struct member 'fuv'.

        Field Documentation

        Blender Source Code

        Coordinates on face/edge number "num" and depth along.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__fuv
      • getFoffset

        public float getFoffset()
                         throws java.io.IOException
        Get method for struct member 'foffset'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__foffset
      • setFoffset

        public void setFoffset​(float foffset)
                        throws java.io.IOException
        Set method for struct member 'foffset'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__foffset
      • getSize

        public float getSize()
                      throws java.io.IOException
        Get method for struct member 'size'.

        Field Documentation

        Blender Source Code

        face normal for volume emission. Size and multiplier so that we can update size when ever.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__size
      • setSize

        public void setSize​(float size)
                     throws java.io.IOException
        Set method for struct member 'size'.

        Field Documentation

        Blender Source Code

        face normal for volume emission. Size and multiplier so that we can update size when ever.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__size
      • getSphdensity

        public float getSphdensity()
                            throws java.io.IOException
        Get method for struct member 'sphdensity'.

        Field Documentation

        Blender Source Code

        Density of sph particle.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__sphdensity
      • setSphdensity

        public void setSphdensity​(float sphdensity)
                           throws java.io.IOException
        Set method for struct member 'sphdensity'.

        Field Documentation

        Blender Source Code

        Density of sph particle.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__sphdensity
      • get_pad

        public CArrayFacade<java.lang.Byte> get_pad()
                                             throws java.io.IOException
        Get method for struct member '_pad'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD___pad
      • set_pad

        public void set_pad​(CArrayFacade<java.lang.Byte> _pad)
                     throws java.io.IOException
        Set method for struct member '_pad'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD___pad
      • getHair_index

        public int getHair_index()
                          throws java.io.IOException
        Get method for struct member 'hair_index'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__hair_index
      • setHair_index

        public void setHair_index​(int hair_index)
                           throws java.io.IOException
        Set method for struct member 'hair_index'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__hair_index
      • getFlag

        public short getFlag()
                      throws java.io.IOException
        Get method for struct member 'flag'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flag
      • setFlag

        public void setFlag​(short flag)
                     throws java.io.IOException
        Set method for struct member 'flag'.
        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__flag
      • getAlive

        public short getAlive()
                       throws java.io.IOException
        Get method for struct member 'alive'.

        Field Documentation

        Blender Source Code

        The life state of a particle.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__alive
      • setAlive

        public void setAlive​(short alive)
                      throws java.io.IOException
        Set method for struct member 'alive'.

        Field Documentation

        Blender Source Code

        The life state of a particle.

        Throws:
        java.io.IOException
        See Also:
        __DNA__FIELD__alive
      • __io__addressof

        public CPointer<ParticleData> __io__addressof()
        Instantiates a pointer on this instance.