AddParticleGoal

Introduced

3.5

Description

Adds a particle goal to a particle simulation. A particle goal is essentially any scene object that attracts particles.

If the object does not have a particle goal property then it is added. This object is connected to a particle cloud object.

Note: This command uses output arguments. C# and some scripting languages (such as JScript, PerlScript and Python) don't support arguments passed by reference so you need to use the best workaround for your situation:

For scripting languages this command returns an ISIVTCollection which you can use to get the output arguments.

For C# you can use the XSIApplication.ExecuteCommand method to call this command. ExecuteCommand packs the output arguments into a C# System.Object containing an Array of the output arguments (see Calling Commands from C#).

Scripting Syntax

    AddParticleGoal( [Target], [InputObj], [Output] )

Parameters

Parameter | Type | Description
Target [in/out] | String | List of particle-emitting objects. Default Value: Selected objects
InputObj [in/out] | String | Goal object
Output [out] | XSICollection containing the new particle goal (X3DObject) | Particle goal generated.

Examples

VBScript Example

    NewScene , false

    ' Create a particle goal
    set myParticleCloud = CreateParticleCloud()
    set myParticleEmitter = CreatePrim( "Sphere", "MeshSurface", "ParticleEmitter" )
    AddParticleEmitter myParticleCloud, myParticleEmitter
    set myParticleGoal = CreatePrim( "Sphere", "MeshSurface", "ParticleGoal")
    AddParticleGoal myParticleCloud, myParticleGoal

See Also

CreateParticleCloud | ApplyParticleShader | AddParticleEmitter | AddParticleForce
SIAddParticleGoal | Particle | ParticleCloud | ParticleType

Autodesk Softimage v7.5