com.hdcookbook.grin.commands
Class SESetVisualRCStateCommand

java.lang.Object
  com.hdcookbook.grin.commands.Command
      com.hdcookbook.grin.commands.SetVisualRCStateCommand
          com.hdcookbook.grin.commands.SESetVisualRCStateCommand

All Implemented Interfaces:

Node, SENode

public class SESetVisualRCStateCommand
extends SetVisualRCStateCommand
implements SENode

Field Summary

Fields inherited from class com.hdcookbook.grin.commands.SetVisualRCStateCommand

activated, gridNumber, handler, runCommands, state

Fields inherited from class com.hdcookbook.grin.commands.Command

show

Constructor Summary

SESetVisualRCStateCommand(SEShow show)

SESetVisualRCStateCommand(SEShow show, boolean activated, int state, VisualRCHandler handler, boolean runCommands)

SESetVisualRCStateCommand(SEShow show, boolean activated, int state, VisualRCHandler handler, boolean runCommands, int gridNumber)

Method Summary

void	accept(SEShowVisitor visitor) Calls the visit method corresponding to this node type.
void	changeFeatureReference(Feature from, Feature to) Change a feature reference from one feature to a new one.
boolean	equals(java.lang.Object other) Override of equals and hashCode to make canonicalization work
java.lang.String	getRuntimeClassName() Returns the class that should be constructed at Show runtime to represent this SENode.
int	hashCode() Override of equals and hashCode to make canonicalization work
void	postProcess(ShowBuilder builder) Do any needed post-processing in this show.
void	setActivated(boolean activated)
void	setRunCommands(boolean runCommands)
void	setState(int state)
void	setup(boolean activated, int state, VisualRCHandler handler, boolean runCommands, int gridNumber) Called from parser
void	setVisualRCHandler(VisualRCHandler handler)
java.lang.String	toString() Return a user-friendly string for this command for debugging purposes.
void	writeInstanceData(GrinDataOutputStream out) Record this node information to the binary file format.

Methods inherited from class com.hdcookbook.grin.commands.SetVisualRCStateCommand

execute, execute, getActivated, getRunCommands, getState, getVisualRCHandler, readInstanceData

Methods inherited from class com.hdcookbook.grin.commands.Command

cloneIfNeeded, deferNextCommands

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SESetVisualRCStateCommand

public SESetVisualRCStateCommand(SEShow show)

SESetVisualRCStateCommand

public SESetVisualRCStateCommand(SEShow show,
                                 boolean activated,
                                 int state,
                                 VisualRCHandler handler,
                                 boolean runCommands)

SESetVisualRCStateCommand

public SESetVisualRCStateCommand(SEShow show,
                                 boolean activated,
                                 int state,
                                 VisualRCHandler handler,
                                 boolean runCommands,
                                 int gridNumber)

Method Detail

setup

public void setup(boolean activated,
                  int state,
                  VisualRCHandler handler,
                  boolean runCommands,
                  int gridNumber)

Called from parser

Parameters:

state - State number, -1 means "current state"

setActivated

public void setActivated(boolean activated)

setState

public void setState(int state)

setVisualRCHandler

public void setVisualRCHandler(VisualRCHandler handler)

setRunCommands

public void setRunCommands(boolean runCommands)

equals

public boolean equals(java.lang.Object other)

Override of equals and hashCode to make canonicalization work

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Override of equals and hashCode to make canonicalization work

Overrides:

hashCode in class java.lang.Object

writeInstanceData

public void writeInstanceData(GrinDataOutputStream out)
                       throws java.io.IOException

Description copied from interface: SENode

Record this node information to the binary file format. An implementation of this method is recommended to call out.writeSuperClassData(this) as the first line of the method to write out data defined in the base class of this Node type.

Specified by:

writeInstanceData in interface SENode

Parameters:

out - The stream to write out.

Throws:

java.io.IOException - if error occurs.

See Also:

GrinDataOutputStream.writeSuperClassData(Feature), GrinDataOutputStream.writeSuperClassData(RCHandler), GrinDataOutputStream.writeSuperClassData(Segment), GrinDataOutputStream.writeSuperClassData(Command)

getRuntimeClassName

public java.lang.String getRuntimeClassName()

Description copied from interface: SENode

Returns the class that should be constructed at Show runtime to represent this SENode.

Specified by:

getRuntimeClassName in interface SENode

Returns:

String A fully qualified classname of a Node at xlet runtime.

accept

public void accept(SEShowVisitor visitor)

Description copied from interface: SENode

Calls the visit method corresponding to this node type.

If you are defining a user-defined feature, there are some restrictions that you'll want to follow. If your extension is a feature that has children, then you should make it a subclass of one of the built-in feature types, Assembly, Modifer or Group. That's because the GRIN compiler defines visitors that need to visit every node in the tree, but these built-in visitors don't know about your extension types. By making your extension type a subclass of one of the standard ones, and by making your accept() method call either visitAssembly(), visitGroup() or visitUserDefinedModifier(), as appropriate, you'll ensure that all the children get visited.

Specified by:

accept in interface SENode

Parameters:

visitor - SEShowVisitor object.

See Also:

SEShowVisitor

postProcess

public void postProcess(ShowBuilder builder)
                 throws java.io.IOException

Do any needed post-processing in this show. The grin compiler works as follows:

• GRIN source file is read and tree is built in memory
• Forward references are resolved (in multiple passes)
• postProcess() is called on every node. During the call, child feature nodes can be added, and parent features can be injected.
• The double-use checker runs to ensure the graph structure is valid.
• Deferred builders (e.g. TranslatorHelper) are called. Deferred builders cannot make changes to the tree structure.

During the post-process phase, a node can add new features to the show, by calling ShowBuilder.addSyntheticFeature(), and it can insert a new feature as the parent of a given feature, by calling ShowBuilder.injectParent(). It can also add segments and handlers by calling the appropriate builder methods.

When a parent is injected, the ShowBuilder calls postProcess() on all nodes automatically, including nodes that are created during the execution of postProcess() in another node.

Specified by:

postProcess in interface SENode

Parameters:

builder - The builder that holds state for the show

Throws:

java.io.IOException - if an error is encountered

See Also:

ShowBuilder.addSyntheticFeature(Feature), ShowBuilder.injectParent(Feature, Feature)

changeFeatureReference

public void changeFeatureReference(Feature from,
                                   Feature to)

Change a feature reference from one feature to a new one. If your node has a reference to the feature from, it should be changed to refer to to. This is called for every node in an SEShow when SENode.injectParent is used.

The ShowBuilder calls changeFeatureReference() on all nodes automatically, including nodes that are created during the execution of postProcess().

Specified by:

changeFeatureReference in interface SENode

See Also:

SENode.changeFeatureReference(Feature, Feature)

toString

public java.lang.String toString()

Return a user-friendly string for this command for debugging purposes.

Overrides:

toString in class Command