ubc.cs.JLog.Animation
Class jAnimate

java.lang.Object
  extended by ubc.cs.JLog.Foundation.jType
      extended by ubc.cs.JLog.Terms.jTerm
          extended by ubc.cs.JLog.Terms.iPredicate
              extended by ubc.cs.JLog.Terms.jBuiltinPredicate
                  extended by ubc.cs.JLog.Terms.jUnaryBuiltinPredicate
                      extended by ubc.cs.JLog.Animation.jAnimate
All Implemented Interfaces:
iType, iUnifiable, iConsultable, iName, iNameArity, iTerm, iValue
Direct Known Subclasses:
jAnimate_addshape, jAnimate_create, jAnimate_delete, jAnimate_getattr, jAnimate_getobject, jAnimate_getshape, jAnimate_init, jAnimate_move, jAnimate_objects, jAnimate_path, jAnimate_removeshape, jAnimate_rotate, jAnimate_setattr, jAnimate_setlevel, jAnimate_setmagnify, jAnimate_setview, jAnimate_shapes, jAnimate_update

public abstract class jAnimate
extends jUnaryBuiltinPredicate

An animation predicate that supports the creation of animation objects, and provides a way to interact with them. Its use is documented in the online Help for the JLog Applet (also available in the "animate_predicates.txt" file in the Help folder).

Author:
Glendon Holst

Field Summary
 
Fields inherited from class ubc.cs.JLog.Terms.jUnaryBuiltinPredicate
rhs
 
Fields inherited from class ubc.cs.JLog.Foundation.jType
type
 
Fields inherited from interface ubc.cs.JLog.Terms.iTerm
EQUAL, GREATER_THAN, LESS_THAN
 
Fields inherited from interface ubc.cs.JLog.Foundation.iType
TYPE_ARITHMETIC, TYPE_ATOM, TYPE_BUILTINPREDICATE, TYPE_COMMAND, TYPE_COMPARE, TYPE_COMPOUND, TYPE_CONS, TYPE_IF, TYPE_INTEGER, TYPE_LIST, TYPE_NULLLIST, TYPE_NUMERICCOMPARE, TYPE_OBJECT, TYPE_OPERATOR, TYPE_OR, TYPE_ORPREDICATE, TYPE_PREDICATE, TYPE_PREDICATETERMS, TYPE_REAL, TYPE_TYPE, TYPE_UNARYARITHMETIC, TYPE_UNARYOPERATOR, TYPE_UNDEFINED, TYPE_VARIABLE
 
Constructor Summary
jAnimate(jTerm t)
           
 
Method Summary
protected abstract  void action(aAnimationEnvironment ae, jTerm[] terms)
           
 void addGoals(jGoal g, iGoalStack goals)
          Adds goal to prove this predicate onto goal stack.
 void addGoals(jGoal g, jVariable[] vars, iGoalStack goals)
          Adds goal to prove this predicate onto goal stack.
 java.lang.String getName()
          Returns the name of this instance.
abstract  int getNumberArguments()
           
 boolean prove(jAnimateGoal ag, aAnimationEnvironment ae)
           
 
Methods inherited from class ubc.cs.JLog.Terms.jUnaryBuiltinPredicate
compareArguments, consult, consultReset, copy, duplicate, duplicate, enumerateVariables, equivalenceArguments, getArguments, getArity, getRHS, isConsultNeeded, prove, registerUnboundVariables, registerVariables, toString, unifyArguments
 
Methods inherited from class ubc.cs.JLog.Terms.jBuiltinPredicate
equivalence, unify
 
Methods inherited from class ubc.cs.JLog.Terms.iPredicate
compare
 
Methods inherited from class ubc.cs.JLog.Terms.jTerm
compare, copy, getTerm, getValue, requiresCompleteVariableState, toString
 
Methods inherited from class ubc.cs.JLog.Foundation.jType
getType, objectToString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

jAnimate

public jAnimate(jTerm t)
Method Detail

getName

public java.lang.String getName()
Description copied from interface: iName
Returns the name of this instance.

Specified by:
getName in interface iName
Specified by:
getName in interface iTerm
Overrides:
getName in class jTerm
Returns:
String containing name of this instance.

getNumberArguments

public abstract int getNumberArguments()

addGoals

public void addGoals(jGoal g,
                     jVariable[] vars,
                     iGoalStack goals)
Description copied from class: iPredicate
Adds goal to prove this predicate onto goal stack. This version is called when the original predicate must duplicate itself (or its arguments). Add goals in the reverse order you want them evaluated.

Overrides:
addGoals in class jUnaryBuiltinPredicate
Parameters:
g - The super-goal jGoal for the sub-goal that this function will add.
vars - The vector of duplicate variables produced from the previous call to registerVariables. Needed for call to duplicate.
goals - The iGoalStack to add the goal to.

addGoals

public void addGoals(jGoal g,
                     iGoalStack goals)
Description copied from class: iPredicate
Adds goal to prove this predicate onto goal stack. This version is called when the original predicate is already duplicated (usually as part of an argument for another predicate). Add goals in the reverse order you want them evaluated.

Overrides:
addGoals in class jUnaryBuiltinPredicate
Parameters:
g - The super-goal jGoal for the sub-goal that this function will add.
goals - The iGoalStack to add the goal to.

prove

public boolean prove(jAnimateGoal ag,
                     aAnimationEnvironment ae)

action

protected abstract void action(aAnimationEnvironment ae,
                               jTerm[] terms)