MAXScript Extensions > MAXScript Extensions for Particle Flow > Particle Flow Classes > Operators > Birth and Death >

# Birth_File : Helper

    Birth_File - superclass: helper; super-superclass:node - 24:0 - classID: #(1962490665, 515064320)

Value > MAXWrapper > Node > Helper > Birth_File

| Particle Flow - Quick Navigation

Description:

The Birth_File operator implements the loading of XML particle files in the Autodesk Maya nCache format used to transfer data from Autodesk Softimage's ICE.

Available in 3ds Max 2012 and higher.

Constructor:

    Birth_File ...

Properties:

## "Particle File" group of controls

     <Birth_File>.Particle_File String default: "" -- filename; Name_of_Particle_File

Get/set the particle file name.

     <Birth_File>.Particle_File_Valid BooleanClass default: false -- boolean

This property will be true if the particle file is valid and false of it is not valid or not specified.

     <Birth_File>.File_Nb_Frames Integer default: 0 -- integer; Number_of_Frames_in_File

Contains the number of frames in the particle file specified by the .Particle_File property.

     <Birth_File>.File_Start Integer default: 0 -- integer; File_Start_Frame

Contains the start frame of the particle file specified by the .Particle_File property.

     <Birth_File>.File_End Integer default: 0 -- integer; File_End_Frame

Contains the end frame of the particle file specified by the .Particle_File property.

     <Birth_File>.File_Rate Float default: 0.0 -- float; Frame_Rate

Contains the frame rate of the particle file specified by the .Particle_File property.

## "Current Frame" group of controls

     <Birth_File>.Nb_Particles_ThisFrame Integer default: 0 -- integer; Number_of_Particles_for_This_Frame

Contains the number of particles in the current frame of the particle file specified by the .Particle_File property.

     <Birth_File>.FileTime Integer default: 0 -- integer; File_Time

Contains the file time of the current frame.

     <Birth_File>.DataFile_ThisFrame UndefinedClass default: undefined -- string; Data_File_Name_for_This_Frame;

Contains the current frame's file name.

Read-only.

## "Time" group of controls

     <Birth_File>.Range_Type Integer default: 0 -- integer

Get/set the range type.

Possible values are:

0 - Use File (default)

1 - Custom

     <Birth_File>.Range_Start Integer default: 0 -- integer

Get/set the Custom Range Start frame.

Used when .RangeType is set to 1.

Corresponds to the "From" spinner in the UI.

     <Birth_File>.Range_End Integer default: 100 -- integer

Get/set the Custom Range End frame.

Used when .RangeType is set to 1.

Corresponds to the "To" spinner in the UI.

     <Birth_File>.Emit_Start Integer default: 0 -- integer

Get/set the frame on which to start the emission.

     <Birth_File>.Speed_Factor Float default: 100.0 -- float

Get/set the Speed Factor percentage value.

Corresponds to the "Speed (%)" spinner in the UI.

     <Birth_File>.Extrapolation_Type Integer default: 1 -- integer

Get/set the extrapolation method.

Possible values are:

0 - Off

1 - Constant (default)

## "Channels" group of controls

     <Birth_File>.Use_Position_Channel BooleanClass default: true -- boolean; Position

Get/set the state of the "Position" checkbox.

When set to true (default), the Position channel will be loaded from the file.

When set to false, the Position channel will not be loaded.

     <Birth_File>.Use_Orientation_Channel BooleanClass default: true -- boolean; Orientation

Get/set the state of the "Orientation" checkbox.

When set to true (default), the Orientation channel will be loaded from the file.

When set to false, the Orientation channel will not be loaded.

     <Birth_File>.Orientation_Up_Vector Integer default: 0  --  integer; Extrapolation_Type

Get/set the state of the "Up Vector" drop-down list.

Possible values are:

0 - Y (default)

1 - Z

     <Birth_File>.Use_Scale_Channel BooleanClass default: true -- boolean; Scale

Get/set the state of the "Scale" checkbox.

When set to true (default), the Scale channel will be loaded from the file.

When set to false, the Scale channel will not be loaded.

     <Birth_File>.Use_Speed_Channel BooleanClass default: true -- boolean; Speed

Get/set the state of the "Speed" checkbox.

When set to true (default), the Speed channel will be loaded from the file.

When set to false, the Speed channel will not be loaded.

     <Birth_File>.Use_Color_Channel BooleanClass default: true -- boolean; Color

Get/set the state of the "Color" checkbox.

When set to true (default), the Color channel will be loaded from the file.

When set to false, the Color channel will not be loaded.

     <Birth_File>.Color_Map_Channel Integer default: 0 -- integer

Get/set the value of the Color Map Channel spinner.

     <Birth_File>.Use_Opacity_Channel BooleanClass default: true -- boolean; Opacity

Get/set the state of the "Opacity" checkbox.

When set to true (default), the Opacity channel will be loaded from the file.

When set to false, the Opacity channel will not be loaded.

     <Birth_File>.Opacity_Map_Channel Integer default: 1 -- integer

Get/set the value of the Opacity Map Channel spinner.

     <Birth_File>.File_Channel_Mask Integer default: 0 -- integer

Contains an integer value where a set bit stands for an existing particle data channel and false bits represent missing channels.

## Birth_File Interfaces:

The following Interfaces are exposed by the Birth_Paint Class:

Interface: action

Interface: operator

Interface: PViewItem

#### See Also

- Birth : Helper

- Birth_Script : Helper

- Birth_Texture : Helper

- Initial_State : Helper

- Particle Flow Classes