PF_Source : GeometryClass

PF_Source - superclass: GeometryClass super-superclass:node - classID: #(1345457306, 0)

Description:

The PF_Source is the viewport icon for a Particle Flow particle system, and also serves as the default emitter. It appears as a separate item in Particle View whose position and width can also be accessed using the properties below.

Constructor:

PF_Source...

Properties:

<PF_Source>.Enable_Particles Boolean default: true -- boolean

Controls the state of the Enbale Particle Emission checkbox in the UI. When set to true, the Particle Flow Source will generate particles.

<PF_Source>.Logo_Size Float default: 10.0 -- animatable; world units

Sets the size of the Particle Flow logo, which appears at the center of the source icon, as well as the arrow that indicates the default direction of particle motion.

<PF_Source>.Emitter_Type Integer default: 0 -- integer

Controls the state of tge Icon Type drop-down list in the UI. Specifies the type of the Icon.

Possible values are:

0: Rectangle

1: Box

2: Circle

3: Sphere

<PF_Source>.Emitter_Length Float default: 20.0 -- animatable; world units

Sets the length of the Rectangle and Box icon types, and the diameter of the Circle and Sphere icon types

<PF_Source>.Emitter_Width Float default: 20.0 -- animatable; world units

Sets the width of the Rectangle and Box icon types. Has no effect with the Circle and Sphere icon types.

<PF_Source>.Emitter_Height Float default: 20.0 -- animatable; world units

Sets the height of the Box icon type. Has no effect unless the Emitter_Type is set to 1 : Box.

<PF_Source>.Show_Logo Boolean default: true -- boolean

When set to true, turns display of the logo (with arrow) on. When false, no logo will be displayed.

<PF_Source>.Show_Emitter Boolean default: true -- boolean

When set to true, turns display of the emitter on. When false, no emitter will be displayed.

<PF_Source>.Quantity_Viewport Float default: 50.0 -- percentage

Sets the percentage of the total number of particles in the system produced in the viewports. Range is from 0.0 to 10000.0.

<PF_Source>.Quantity_Render Float default: 100.0 -- percentage

Sets the percentage of the total number of particles in the system produced at render time. Range is from 0.0 to 10000.0.

<PF_Source>.Select_By_Particle_ID Integer default: 1 -- integer

Corresponds to the ID field in the UI. Sets the ID number of the particle to select.

<PF_Source>.Clear_Selection Boolean default: false -- boolean

Corresponds to the Clear Selection checkbox in the UI. When checked, selecting a new particle by ID will clear the existing selection.

<PF_Source>.Selected_Particles ArrayParameter default: #() -- int array

Returns an array of selected particle indices.

<PF_Source>.Selection_ActionLists node array

Returns an array of selected ActionList nodes.

<PF_Source>.Selection_Level Integer default: 0 -- integer

Get/Set the selection level.

Possible values are:

0: Object Level

1: Particle Level

2: Event Level

<PF_Source>.Particle_Amount_Limit Integer default: 100000 -- integer

The maximum number of particles the system may have. Range is from 1 to 10000000.

<PF_Source>.Integration_for_Viewport Integer default: 0 -- integer

Set the integration step for animation playback in the viewports.

Possible values are:

0: Frame

1: Half Frame

2: 1/4

3: 1/8

<PF_Source>.Integration_for_Render Integer default: 1 -- integer

Set the integration step at render time.

Possible values are:

0: Frame

1: Half Frame

2: 1/4

3: 1/8

4: 8 Ticks

5: 4 Ticks

6: 2 Ticks

7: 1 Tick

<PF_Source>.Enable_Script_for_Every_Step_Update Boolean default: false -- boolean

When set to true causes the script assigned to .Every_Step_Update_Script to be executed at each integration step.

Note:

The Every Step Update script is evaluated at the end of each integration step, after all actions in the particle system are evaluated, and all particles are finally in their respective particle groups (events).

<PF_Source>.Every_Step_Update_Script String

Specifies the script to be executed at every integration step. The default script modifies particle speed and direction, causing particles to follow a wavy path.

<PF_Source>.Use_File_for_Every_Step_Update Boolean default: false -- boolean

When set to true causes the script file assigned to .EveryStepUpdateScriptFile to be executed at each integration step.

<PF_Source>.Every_Step_Update_Script_File Filename alias: everyStepUpdateScriptFile

Specifies the script file to be executed at every integration step.

<PF_Source>.Enable_Script_for_Final_Step_Update Boolean default: false -- boolean

When set to true causes the script assigned to .Final_Step_Update_Script to be executed after the final integration step.

Note:

The Final Step Update script is executed after the last integration step has been completed for each frame that you view (or render).

<PF_Source>.Final_Step_Update_Script String

Specifies the script to be executed after the final integration step.

<PF_Source>.Use_File_for_Final_Step_Update Boolean default: false -- boolean

When set to true causes the script file assigned to .EveryStepUpdateScriptFile to be executed at each integration step.

<PF_Source>.Final_Step_Update_Script_File UndefinedClass default: undefined -- filename

Specifies the script file to be executed after the final integration step.

<PF_Source>.X_Coordinate Integer default: 0 -- integer

Returns an X Coordinate of the Emitter in the Particle View

<PF_Source>.Y_Coordinate Integer default: 0 -- integer

Returns an Y Coordinate of the Emitter in the Particle View

<PF_Source>.Z_Order Integer default: 0 -- integer

Get/Set the Z Order for drawing the Emitter in the Particle View.

<PF_Source>.width Integer default: 180 -- integer

Get/Set the Width of the PF_Source item in Particle View.

PF_Source Interfaces:

Interface: action

Interface: initialEvents

Interface: particleObjectExt

Interface: pfSystem

Interface: PViewItem