Share

Interface: PViewItem

Methods:

<integer><PViewItem>.numPViewParamBlocks()      

Returns the number of Particle View ParameterBlocks.

<maxObject><PViewItem>.getPViewParamBlock <index>index   

Returns the indexed Particle View ParameterBlocks.

<boolean><PViewItem>.hasComments <node>actionNode 

Returns true when the supplied action node has comments.

<string><PViewItem>.getComments <node>actionNode 

Returns the comment of the specified action node as string.

<void><PViewItem>.setComments <node>actionNode <string>comments 

Sets the comment of the specified action node to the supplied string.

EXAMPLES AND RESULTS:

   ParticleFlow.openParticleView() --open Particle View to see results
   ev = Event() --create an empty event
   --> $Event:Event 002 @ [0.000000,0.000000,0.000000]
   particleFlow.beginEdit() --Disable auto-event-encapsulation
   --> OK
   bt = birth() --A Birth Action!
   --> $Birth:Birth 001 @ [0.000000,0.000000,0.000000]
   particleFlow.endEdit() --Enable auto-event-encapsulation
   --> OK
   ev.appendAction bt --Insert the Birth in the Event
   --> true
   ev.numPViewParamBlocks() --Check the number of PBlocks
   --> 0
   ev.hasComments bt --Check for comments - none
   --> false
   ev.setComments bt "Happy Birthday!" --Set a comment...
   --> OK
   ev.getComments bt --...and read it back
   --> "Happy Birthday!"

This Interface is available in:

Was this information helpful?