Surface Flow procedures
 
 
 

There are several global procedures provided with the Surface Flow effect that allow you to query information about the surface flows in your scene.

int isSurfaceFlow( string $flow )

Returns 1 if the flow object you specify is the root object of a surface flow effect. Otherwise, it returns 0.

string[] surfaceFlowParticles( string $flow )

Returns the names of all of the particle objects that are affected by the surface flow you specify.

int isParticleInSurfaceFlow( string $flow, string $particle )

Returns 1 if the particle object you specify is affected by the surface flow you specify. Otherwise, it returns 0.

string[] surfaceFlowsDrivingParticle( string $particle )

Returns a string array containing the list of all surface flows in your scene that affect the particle object you specify.

string[] selectedSurfaceFlows()

Returns all of the surface flow objects from the selection list in the order they were selected.

string[] selectedSurfaceFlowsAndSurfaces()

Returns all of the surface flow objects and NURBS surfaces from the selection list in the order they were selected.

string surfaceFlowActualSurface( string $flow )

Returns the name of the NURBS surface associated with the surface flow you specify. This is the surface selected at the time the surface flow was created.

string surfaceFlowReferenceSurface( string $flow )

Returns the name of the reference NURBS surface associated with the surface flow you specify. At the time of creation, the surface flow effect makes an exact copy of the selected surface to use as a reference. All objects created for the effect fall under the reference object rather than cluttering the actual surface node.

string[] surfaceFlowLofts( string $flow )

Returns the names of the edge, min, and max lofts used to define the boundary for the surface flow you specify.

string[] surfaceFlowEdgeCurves( string $flow )

Returns all of the curves used to calculate the edge loft for the surface flow you specify.

string[] surfaceFlowMaxCurves( string $flow )

Returns all of the curves used to calculate the max loft for the surface flow you specify.

string[] surfaceFlowMinCurves( string $flow )

Returns all of the curves used to calculate the min loft for the surface flow you specify.

string[] surfaceFlowCurves( string $flow )

Returns all of the curves used to calculate all of the lofts for the surface flow you specify.

string surfaceFlowEmitter( string $flow )

Returns the name of the emitter that is attached to the first manipulator of the surface flow you specify.

string surfaceFlowGoal( string $flow )

Returns the name of the goal object being used to control the motion of the particles associated with the surface flow you specify.

string[] surfaceFlowManips( string $flow )

Returns the names of all of the manipulators for the surface flow you specify.

string[] surfaceFlowRamps( string $flow )

The surface flow effect is achieved through the manipulation of ramp textures and goal objects. This procedure returns the names of all of the ramp textures used by the surface flow you specify.

The number of ramps created depends on the values of the three resolution options used to create the effect.The ramps are used as a part of the construction history for the animation of the effect not as a part of a rendering network. The ramps don’t appear in the Texture sections in the Visor or HyperShade because they can easily outnumber the rendering textures in the scene. The ramps do appear in the networks drawn in the main windows of the HyperGraph and HyperShade because they are useful parts of those networks.