The flare Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The flare Reference Manual

This is the flare Reference Manual, version 0.2.0, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:39:01 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

What

Flare is a library designed to allow quick and precise particle effect creations. It does not concern itself with displaying and only with the management and movement of particles. As such, it can easily be integrated into any existing or future application.

So What's Different? Why Should I Use This?

Usually in particle systems the way you control things is by describing various states on the emitter. Flare instead takes a much more fine-grained approach by allowing you to control individual particles and describe their movement and change over time.

How To

As Flare does not do any graphics on its own, you will first have to create something that can render graphics of some kind. Once you have that, you should subclass particle to create your own particle types. You should also implement methods on paint so that the particle can be drawn. The last thing that's needed is a method on call-with-translation that should perform a translation on your drawing target. That should settle everything in terms of hooking Flare up to your graphics system.

Next you will need to keep a scene instance into which your particles will be spawned and your animations will be played. You should then call paint on the scene object in your drawing loop and call start on the scene object when your application is initialised.

Finally, the exciting part: defining animation progressions. This happens through define-progression, which creates a globally named progression-definition. The body of a definition is made up of a series of intervals and animations. Each animation is composed of a selector and a bunch of changes. The selector decides to which units in the scene the changes should apply, and the changes decide what happens while the animation runs.

So let's look at a simple example. We'll create a particle that spins on a circle.

(define-progression spinner
  0 0 (T (enter ring :size 100 :children (sphere :size 10)))
  0 T (> (increase angle :by 360 :for 1)))

This defines a progression named spinner with two animations

Here sphere is the name of a simple particle. If you named your particle class something else, replace that with your own. In order to make the progression have an effect on our scene, we need to instantiate it and add it to the scene. You can instantiate a progression with progression-instance and add it to the scene by enter. Finally, we'll want to start it to see it in action.

(start (enter (progression-instance 'spinner) scene-instance))

We can change the example to be a bit more exciting by making it be a pendulum instead of a mere spinner. To do this we substitute a calc cahnge for the increase change:

(calc angle :to (+ 90 (* (sin (* clock 4)) 40)))

You can redefine the progression on the fly while it is still running and it should gracefully update on your screen. This should allow you to easily hack out rather complex animations. If you want to start again from the beginning, call reset on the progression instance.

An example implementation of all this including some nifty show progressions can be found in the flare-viewer system. You can also use this system yourself to play around with progressions for a bit.

Internals

Flare must handle two parts-- one the animation itself, and two the objects in the scene.

Scene Graph

The scene graph is made up of units and containers. Each unit must have a symbol for a name and each container has some data structure that can hold other objects. You can add and remove objects from a container using enter and leave respectively. If you need to iterate over the entirety of the scene graph referenced by a container, use map-container-tree or do-container-tree. Since containers should only hold units, you can use container-unit for further nesting levels. At the bottom of the entire thing should be a scene-graph, which allows you to retrieve any unit within it by its name using the unit function.

Building up on this are the scene and entity classes. The scene furthermore is paintable, animatable, and a clock, so that it can be drawn, animated, and can keep the time. An entity can always contain further entities, and aside from being paintable and animatable as well, it also always has a location vector so that we can move it around. All entities are always relative to their parent in their location. The transformation of this is achieved by a call-with-translation around each paint call.

Any animatable can keep a set of progression instances that will be automatically updated when the animatable is, and thus carry out their transformations for as long as they should be active.

Animation

The animation process is divided up into progression-definitions, progressions, animations, and changes. Progression-definitions merely exist as containers to instantiate and update progressions from. When their animations slot is set, they automatically update all instances.

A progression is more complicated however as it has to actually manage all the various animations, ensure they're run in the proper order and for just long enough, and it has to make it possible to rewind everything and reset the state of the scene to how things were before. Thus, progressions each have three vectors of present-animations, past-animations, and future-animations. Since they must also know whom to act upon, they keep a back-link to the animatable that they should modify.

Each update then the progression checks if any new animations now have their time to shine and if so, move them onto the present set. All the present animations then get ticked with their appropriate time-step and the animatable passed along. Finally, all animations that are past their prime and have exceeded their duration are moved off onto the past set. If there are no more future or present animations available, the progression knows it's done and stops itself.

Now, when a progression is reset, it shuffles all the past animations into the present set, reorders everything in reverse, and then resets each animation in sequence. Each animation then causes each change to be reset, hopefully one by one back-tracking all the changes that were made to the scene.

Thus by coupling a reset with an explicit clock-set and an update, a progression can be explicitly fast-forwarded or rewound to any particular point in its life-cycle and all the updates should stay consistent throughout.

When an animation is ticked, the actual entity selection process starts to happen. When the progression is defined, each animation must be supplied with a selector, which is compiled down to a chain of function calls that either expand or limit the set of applicable objects. For a list of the possible selector constraints, see compile-constraint. Each change of the animation is then ticked with each object that passed the constraint functions.

Finally, changes. Changes are divided into operations and tweens. Operations change the scene in some way by adding, removing, or moving entities around. They should not affect any internal state of entities and only affect the object tree. Tweens on the other hand do the opposite and should only modify the internal state of whatever object they are passed in their tick call, but should never change the object tree in any way.

Flare supplies several default changes, some of which have parsers (define-change-parser) so that they can actually be used from a progression definition. On the operations side, we have enter-operation and leave-operation used to add or remove objects respectively. The enter-operation is significant in the sense that it uses a creator function that can potentially instantiate arbitrarily many or arbitrarily deep structures. On the tween side we have several mixins to make the definition of your own tweens easier (range-tween constant-tween slot-tween accessor-tween), from which two usable tweens arise, range-accessor-tween (set) and increase-accessor-tween (increase). There's one more notable tween to mention: call-accessor-tween (calc), which sets the slot according to a user-definable function.

Each change must know by itself how to reset the objects it acted upon to their initial state. The slot-tween and accessor-tween know how to do this by saving the original value of each object they act upon. Similarly, the enter and leave operations keep track of where they added or removed which objects.

Videos

Here are some demo videos made during various points in the development of Flare.

Youtube Video

Youtube Video

Youtube Video

Youtube Video


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 flare

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://github.com/Shinmera/flare

License

Artistic

Description

Easy particle systems with fine grained control.

Version

0.2.0

Dependencies
Source

flare.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 flare.asd

Location

flare.asd

Systems

flare (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 flare/package.lisp

Parent

flare (system)

Location

package.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 flare/toolkit.lisp

Dependency

package.lisp (file)

Parent

flare (system)

Location

toolkit.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 flare/queue.lisp

Dependency

toolkit.lisp (file)

Parent

flare (system)

Location

queue.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 flare/indexed-set.lisp

Dependency

queue.lisp (file)

Parent

flare (system)

Location

indexed-set.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 flare/easings.lisp

Dependency

indexed-set.lisp (file)

Parent

flare (system)

Location

easings.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.7 flare/clock.lisp

Dependency

easings.lisp (file)

Parent

flare (system)

Location

clock.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.8 flare/container.lisp

Dependency

clock.lisp (file)

Parent

flare (system)

Location

container.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.9 flare/paintable.lisp

Dependency

container.lisp (file)

Parent

flare (system)

Location

paintable.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.10 flare/animation.lisp

Dependency

paintable.lisp (file)

Parent

flare (system)

Location

animation.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.11 flare/change.lisp

Dependency

animation.lisp (file)

Parent

flare (system)

Location

change.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.12 flare/parser.lisp

Dependency

change.lisp (file)

Parent

flare (system)

Location

parser.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.13 flare/scene.lisp

Dependency

parser.lisp (file)

Parent

flare (system)

Location

scene.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.14 flare/forms.lisp

Dependency

scene.lisp (file)

Parent

flare (system)

Location

forms.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.15 flare/documentation.lisp

Dependency

forms.lisp (file)

Parent

flare (system)

Location

documentation.lisp


Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 flare

Source

package.lisp (file)

Nickname

org.shirakumo.flare

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.2 flare-indexed-set

Source

package.lisp (file)

Nickname

org.shirakumo.flare.indexed-set

Use List
Used By List

flare

Exported Definitions
Internal Definitions

Previous: , Up: Packages   [Contents][Index]

4.3 flare-queue

Source

package.lisp (file)

Nickname

org.shirakumo.flare.queue

Use List
Used By List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: define-change-parser TYPE ARGS &body BODY

Define a parser for the given type of change.

Package

flare

Source

change.lisp (file)

Macro: define-easing NAME (X) &body BODY

Shorthand macro to define an easing function.

See EASING

Package

flare

Source

easings.lisp (file)

Macro: define-progression NAME &body INTERVALS

Convenience macro to define a global progression.
Returns the progression name.

The formal specification of the body intervals is as follows:
body ::= interval*
interval ::= start [end] animation*
animation ::= (selector change*)
change ::= (change-type argument*)
start — An integer (in seconds) that represents the starting time of the animations
end — An integer (or T, indicating infinity) that represents the ending time of the animations
selector — A valid selector as per COMPILE-SELECTOR
change — A valid change as per COMPILE-CHANGE

If the END is not specified for a given interval, then the next START is taken as the end. If no next start exists, then the end is T. In order to allow brevity, multiple animations can be specified between two time codes. This is then normalised into the strict form of
(START DURATION ANIMATION) as per PARSE-INTERVALS.

An example definition follows:

(define-progression foo
0 (T (enter ring :name :ring :contents (bullet :size 2 :count 20))) 0 8 (:ring (increase size :by 2))
0 20 (:ring (set angle :to 1000 :ease ’quad-in-out))
((:ring >) (set size :to 50))
20 (:ring (leave)))

At time 0, a ring is created with name :ring and 20 bullets of size 2 as its children. It is entered into the scene-graph. Then from time 0 to 8, the ring’s size is increased by 2 every second. Simultaneously from time 0 to 20 the ring’s angle is increased to 1000, eased by the quad-in-out interpolation and the ring’s children (the 20 bullets) increase in size to 50. At time 20, the ring is removed from the scene-graph again.

See PROGRESSION-DEFINITION
See COMPILE-ANIMATIONS

Package

flare

Source

parser.lisp (file)

Macro: do-container-tree (ITEM CONTAINER &optional RETURN) &body BODY

Iterates over all descendants of CONTAINER

See MAP-CONTAINER-TREE

Package

flare

Source

container.lisp (file)

Macro: do-queue (VALUE QUEUE &optional RESULT) &body BODY

Iterates over each value in the queue in order.

See QUEUE

Package

flare-queue

Source

queue.lisp (file)

Macro: do-set (VALUE QUEUE &optional RESULT) &body BODY

Iterates over all elements of the set in order.

See INDEXED-SET

Package

flare-indexed-set

Source

queue.lisp (file)

Macro: with-translation (VEC TARGET) &body BODY

Shorthand macro for translation.

See CALL-WITH-TRANSLATION

Package

flare

Source

paintable.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: cell-insert-before CELL NEIGHBOR

Inserts the cell before its neighbour, making sure to keep all links updated.

See CELL

Package

flare-queue

Source

queue.lisp (file)

Function: cell-remove CELL

Removes the cell out of the link chain, making sure to keep all links updated. Unless the cell is the only item in the link chain, its left/right slots are not modified.

See CELL

Package

flare-queue

Source

queue.lisp (file)

Function: clear-queue QUEUE

Removes all elements from the queue.

See QUEUE

Package

flare-queue

Source

queue.lisp (file)

Function: clear-set QUEUE

Removes all values from the set.

See INDEXED-SET

Package

flare-indexed-set

Source

queue.lisp (file)

Function: coerce-queue QUEUE TYPE

Allows coercing the queue to:

queue, list, vector, or sequence.

See QUEUE

Package

flare-queue

Source

queue.lisp (file)

Function: coerce-set SET TYPE

Allows coercing the set to:

indexed-set, hash-table, queue, list, vector, or sequence.

See INDEXED-SET
See COERCE-QUEUE

Package

flare-indexed-set

Source

indexed-set.lisp (file)

Function: dequeue QUEUE

Pops the next value off the front of the queue.
The second value indicates whether there was any element in the queue at all.

See QUEUE

Package

flare-queue

Source

queue.lisp (file)

Function: ease X BY &optional FROM TO

Shorthand function to perform an easing interpolation.

X must be a float between 0 and 1
BY must name an easing function
FROM and TO must be REALs specifying the boundaries of the easing.

Package

flare

Source

easings.lisp (file)

Function: easing NAME

Accessor to the easing function associated with the given name, if any.

See *EASINGS*

Package

flare

Source

easings.lisp (file)

Writer

(setf easing) (function)

Function: (setf easing) FUNC NAME
Package

flare

Source

easings.lisp (file)

Reader

easing (function)

Function: enqueue VALUE QUEUE

Inserts the given value at the end of the queue.

See QUEUE

Package

flare-queue

Source

queue.lisp (file)

Function: in-queue-p VALUE QUEUE

Returns T if the given value is found in the queue.

See QUEUE

Package

flare-queue

Source

queue.lisp (file)

Function: in-set-p VALUE SET

Returns T if the value is contained in the set.

See INDEXED-SET

Package

flare-indexed-set

Source

indexed-set.lisp (file)

Function: left INSTANCE

Accesses the cell left to the current cell.

See CELL

Package

flare-queue

Source

queue.lisp (file)

Writer

(setf left) (function)

Function: (setf left) VALUE INSTANCE
Package

flare-queue

Source

queue.lisp (file)

Reader

left (function)

Function: make-indexed-set ()

Creates a new indexed set.

See INDEXED-SET

Package

flare-indexed-set

Source

indexed-set.lisp (file)

Function: make-queue ()

Creates a new queue instance.

See QUEUE

Package

flare-queue

Source

queue.lisp (file)

Function: map-container-tree FUNCTION CONTAINER

Recursively maps FUNCTION over all descendants of CONTAINER.

See CONTAINER

Package

flare

Source

container.lisp (file)

Function: map-queue FUNCTION QUEUE

Maps the function over all values in the queue in order.

See QUEUE

Package

flare-queue

Source

queue.lisp (file)

Function: map-set FUNCTION QUEUE

Maps the function over all elements of the set in order.

See INDEXED-SET

Package

flare-indexed-set

Source

queue.lisp (file)

Function: print-container-tree CONTAINER &optional DEPTH

Prints the entire CONTAINER tree hierarchy nicely to the given STREAM.

See CONTAINER

Package

flare

Source

container.lisp (file)

Function: progression-definition NAME

Accessor to the global progression definition by name.

See *PROGRESSIONS*

Package

flare

Source

parser.lisp (file)

Writer

(setf progression-definition) (function)

Function: (setf progression-definition) PROGRESSION NAME
Package

flare

Source

parser.lisp (file)

Reader

progression-definition (function)

Function: queue-first QUEUE

Returns the first (front) value in the queue if there is any.
The second value indicates whether there was any element in the queue at all.

See QUEUE

Package

flare-queue

Source

queue.lisp (file)

Function: queue-index-of VALUE QUEUE

Returns the index of the value in the queue.
If the value could not be found, NIL is returned instead.

This is potentially very costly as it might have to scan the entire queue.

See QUEUE

Package

flare-queue

Source

queue.lisp (file)

Function: queue-last QUEUE

Returns the last (end) value in the queue if there is any.
The second value indicates whether there was any element in the queue at all.

See QUEUE

Package

flare-queue

Source

queue.lisp (file)

Function: queue-remove VALUE QUEUE

Removes the given value from the queue.

This is potentially very costly as it might have to scan the entire queue.

See QUEUE

Package

flare-queue

Source

queue.lisp (file)

Function: queue-size QUEUE

Returns the number of elements in the queue.

See QUEUE

Package

flare-queue

Source

queue.lisp (file)

Function: queue-value-at N QUEUE

Returns the value at the given position in the queue.
The second value is NIL if the position is out of range.

This is potentially very costly as it might have to scan the entire queue.

See QUEUE

Package

flare-queue

Source

queue.lisp (file)

Writer

(setf queue-value-at) (function)

Function: (setf queue-value-at) VALUE N QUEUE
Package

flare-queue

Source

queue.lisp (file)

Reader

queue-value-at (function)

Function: remove-easing NAME

Removes the easing function associated with the given name.

See *EASINGS*

Package

flare

Source

easings.lisp (file)

Function: remove-progression-definition NAME

Remove the global progression definition by name

See *PROGRESSIONS*

Package

flare

Source

parser.lisp (file)

Function: right INSTANCE

Accesses the cell right to the current cell.

See CELL

Package

flare-queue

Source

queue.lisp (file)

Writer

(setf right) (function)

Function: (setf right) VALUE INSTANCE
Package

flare-queue

Source

queue.lisp (file)

Reader

right (function)

Function: set-add VALUE SET

Add a new value to the set.

Returns two values, the value that was added, and whether it was added as a new element to the set. If it already existed, the second value is NIL.

See INDEXED-SET

Package

flare-indexed-set

Source

indexed-set.lisp (file)

Function: set-first QUEUE

Returns the first item in the set.

See INDEXED-SET

Package

flare-indexed-set

Source

queue.lisp (file)

Function: set-index-of VALUE QUEUE

Returns the index of the value in the set.

See INDEXED-SET

Package

flare-indexed-set

Source

queue.lisp (file)

Function: set-last QUEUE

Returns the last item in the set.

See INDEXED-SET

Package

flare-indexed-set

Source

queue.lisp (file)

Function: set-remove VALUE SET

Remove a value from the set.

Returns two values, the set that was modified, and whether the value existed in the set to begin with. If it did not, the second value is NIL.

See INDEXED-SET

Package

flare-indexed-set

Source

indexed-set.lisp (file)

Function: set-size QUEUE

Returns the number of items in the set.

See INDEXED-SET

Package

flare-indexed-set

Source

queue.lisp (file)

Function: set-value-at N QUEUE

Returns the value at the given index in the set.

See INDEXED-SET

Package

flare-indexed-set

Source

queue.lisp (file)

Writer

(setf set-value-at) (function)

Function: (setf set-value-at) VALUE N QUEUE
Package

flare-indexed-set

Source

queue.lisp (file)

Reader

set-value-at (function)

Function: value INSTANCE

Accesses the value contained in a queue cell.

See CELL

Package

flare-queue

Source

queue.lisp (file)

Writer

(setf value) (function)

Function: (setf value) VALUE INSTANCE
Package

flare-queue

Source

queue.lisp (file)

Reader

value (function)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Generic functions

Generic Function: add-progression PROGRESSION ANIMATABLE

Attach a new progression onto the animatable.

See PROGRESSION
See ANIMATABLE

Package

flare

Source

animation.lisp (file)

Methods
Method: add-progression (DEFINITION progression-definition) (ANIMATABLE animatable)
Method: add-progression (PROGRESSION progression) (ANIMATABLE animatable)
Generic Function: angle ARC

Accessor to the angle.

See ARC

Package

flare

Source

forms.lisp (file)

Writer

(setf angle) (generic function)

Methods
Method: angle (ARC arc)

automatically generated reader method

Generic Function: (setf angle) NEW-VALUE OBJECT
Package

flare

Reader

angle (generic function)

Methods
Method: (setf angle) VAL (ARC arc) after
Source

forms.lisp (file)

Method: (setf angle) NEW-VALUE (ARC arc)

automatically generated writer method

Source

forms.lisp (file)

Generic Function: animatable OBJECT

Accessor to the animatable the progression is acting upon.

See PROGRESSION

Package

flare

Writer

(setf animatable) (generic function)

Methods
Method: animatable (PROGRESSION progression)

automatically generated reader method

Source

animation.lisp (file)

Generic Function: (setf animatable) NEW-VALUE OBJECT
Package

flare

Reader

animatable (generic function)

Methods
Method: (setf animatable) NEW-VALUE (PROGRESSION progression)

automatically generated writer method

Source

animation.lisp (file)

Generic Function: animations PROGRESSION-DEFINITION

Accessor to the vector of animations that the progression holds.

Package

flare

Source

animation.lisp (file)

Writer

(setf animations) (generic function)

Methods
Method: animations (PROGRESSION-DEFINITION progression-definition)

automatically generated reader method

Generic Function: (setf animations) NEW-VALUE OBJECT
Package

flare

Reader

animations (generic function)

Methods
Method: (setf animations) ANIMATIONS (PROGRESSION progression)
Source

animation.lisp (file)

Method: (setf animations) VAL (DEFINITION progression-definition) after
Source

animation.lisp (file)

Method: (setf animations) ANIMATIONS (DEFINITION progression-definition)
Source

animation.lisp (file)

Generic Function: beginning ANIMATION

Accessor to the beginning (in seconds) at which the animation should start.

See ANIMATION

Package

flare

Source

animation.lisp (file)

Writer

(setf beginning) (generic function)

Methods
Method: beginning (ANIMATION animation)

automatically generated reader method

Generic Function: (setf beginning) NEW-VALUE OBJECT
Package

flare

Reader

beginning (generic function)

Methods
Method: (setf beginning) NEW-VALUE (ANIMATION animation)

automatically generated writer method

Source

animation.lisp (file)

Generic Function: call-with-translation FUNC TARGET VEC

Call FUNC after having performed a translation on TARGET by VEC.

Package

flare

Source

paintable.lisp (file)

Generic Function: changes ANIMATION

Accessor to the list of changes that the animation executes.

See ANIMATION

Package

flare

Source

animation.lisp (file)

Writer

(setf changes) (generic function)

Methods
Method: changes (ANIMATION animation)

automatically generated reader method

Generic Function: (setf changes) NEW-VALUE OBJECT
Package

flare

Reader

changes (generic function)

Methods
Method: (setf changes) NEW-VALUE (ANIMATION animation)

automatically generated writer method

Source

animation.lisp (file)

Generic Function: clear CONTAINER

Removes all objects from the CONTAINER.

Returns the object given.

See CONTAINER

Package

flare

Source

container.lisp (file)

Methods
Method: clear (CONTAINER container)
Generic Function: clock CLOCK

Accessor to the current time in the clock.

Note that the current time in the clock must not necessarily be 100% accurate. In order to get perfectly accurate current time of the clock, you must call UPDATE on it before retrieving its current time value with CLOCK.

See CLOCK

Package

flare

Source

clock.lisp (file)

Writer

(setf clock) (generic function)

Methods
Method: clock (CLOCK clock)

automatically generated reader method

Generic Function: (setf clock) NEW-VALUE OBJECT
Package

flare

Reader

clock (generic function)

Methods
Method: (setf clock) NEW (PROGRESSION progression) before
Source

animation.lisp (file)

Method: (setf clock) NEW-VALUE (CLOCK clock)

automatically generated writer method

Source

clock.lisp (file)

Generic Function: creator OBJECT

Accessor to the function that upon calling instantiates one or more objects.

See ENTER-OPERATION

Package

flare

Writer

(setf creator) (generic function)

Methods
Method: creator (ENTER-OPERATION enter-operation)

automatically generated reader method

Source

change.lisp (file)

Generic Function: (setf creator) NEW-VALUE OBJECT
Package

flare

Reader

creator (generic function)

Methods
Method: (setf creator) NEW-VALUE (ENTER-OPERATION enter-operation)

automatically generated writer method

Source

change.lisp (file)

Generic Function: deregister UNIT SCENE-GRAPH

Deregisters the unit with the scene-graph, making it accessible by its name.
Any unit that leaves from any part of the scene-graph must be deregistered by this function. This should happen automatically provided you use the CONTAINER-UNIT class for containers inside the scene-graph. Thus you need not call this function unless you implement your own container.

See UNIT
See SCENE-GRAPH

Package

flare

Source

container.lisp (file)

Methods
Method: deregister (UNIT container-unit) (SCENE-GRAPH scene-graph) after
Method: deregister (UNIT unit) (SCENE-GRAPH scene-graph)
Method: deregister (UNIT unit) (SCENE-GRAPH scene-graph) around
Generic Function: duration ANIMATION

Accessor to the duration (in seconds) that the animation should be active for. Can also be T, in which case the animation should go on forever.

See ANIMATION

Package

flare

Source

animation.lisp (file)

Writer

(setf duration) (generic function)

Methods
Method: duration (ANIMATION animation)

automatically generated reader method

Generic Function: (setf duration) NEW-VALUE OBJECT
Package

flare

Reader

duration (generic function)

Methods
Method: (setf duration) NEW-VALUE (ANIMATION animation)

automatically generated writer method

Source

animation.lisp (file)

Generic Function: ease-object FROM TO X BY

Shorthand function to ease a range.

FROM and TO must be matching objects

By default works on REALs and VECs.

See EASE

Package

flare

Source

easings.lisp (file)

Methods
Method: ease-object (FROM vec3) (TO vec3) X BY
Method: ease-object (FROM real) (TO real) X BY
Generic Function: enter UNIT SCENE-GRAPH

Adds the given UNIT into the CONTAINER.

Returns the unit given.

See UNIT
See CONTAINER

Package

flare

Source

container.lisp (file)

Methods
Method: enter (DEFINITION progression-definition) (ANIMATABLE animatable)
Source

animation.lisp (file)

Method: enter (PROGRESSION progression) (ANIMATABLE animatable)
Source

animation.lisp (file)

Method: enter (UNIT unit) (CONTAINER container-unit) after
Method: enter (UNIT container-unit) (SCENE-GRAPH scene-graph) before
Method: enter (UNIT unit) (SCENE-GRAPH scene-graph) after
Method: enter THING (CONTAINER container)
Generic Function: future-animations PROGRESSION

Accessor to the vector of animations that have yet to become activated after the current clock time.

See PROGRESSION

Package

flare

Source

animation.lisp (file)

Writer

(setf future-animations) (generic function)

Methods
Method: future-animations (PROGRESSION progression)

automatically generated reader method

Generic Function: (setf future-animations) NEW-VALUE OBJECT
Package

flare

Reader

future-animations (generic function)

Methods
Method: (setf future-animations) NEW-VALUE (PROGRESSION progression)

automatically generated writer method

Source

animation.lisp (file)

Generic Function: instances PROGRESSION-DEFINITION

Accessor to all progression instances that were created from this definition.

See PROGRESSION-DEFINITION

Package

flare

Source

animation.lisp (file)

Writer

(setf instances) (generic function)

Methods
Method: instances (PROGRESSION-DEFINITION progression-definition)

automatically generated reader method

Generic Function: (setf instances) NEW-VALUE OBJECT
Package

flare

Reader

instances (generic function)

Methods
Method: (setf instances) NEW-VALUE (PROGRESSION-DEFINITION progression-definition)

automatically generated writer method

Source

animation.lisp (file)

Generic Function: leave UNIT SCENE-GRAPH

Removes the given UNIT from the CONTAINER.

Returns the unit given.

See UNIT
See CONTAINER

Package

flare

Source

container.lisp (file)

Methods
Method: leave (PROGRESSION progression) (ANIMATABLE animatable)
Source

animation.lisp (file)

Method: leave (UNIT unit) (CONTAINER container-unit) after
Method: leave (UNIT container-unit) (SCENE-GRAPH scene-graph) before
Method: leave (UNIT unit) (SCENE-GRAPH scene-graph) after
Method: leave THING (CONTAINER container)
Generic Function: location ENTITY

Accessor to the location of the entity.

See ENTITY

Package

flare

Source

scene.lisp (file)

Writer

(setf location) (generic function)

Methods
Method: location (ENTITY entity)

automatically generated reader method

Generic Function: (setf location) NEW-VALUE OBJECT
Package

flare

Reader

location (generic function)

Methods
Method: (setf location) VALUE (FORMATION formation) after
Source

forms.lisp (file)

Method: (setf location) NEW-VALUE (ENTITY entity)

automatically generated writer method

Source

scene.lisp (file)

Generic Function: name UNIT

Reader to the name of the unit.

See UNIT

Package

flare

Source

container.lisp (file)

Methods
Method: name (UNIT unit)

automatically generated reader method

Generic Function: name-map SCENE-GRAPH

Accessor to the name table of the scene-graph.

See SCENE-GRAPH

Package

flare

Source

container.lisp (file)

Writer

(setf name-map) (generic function)

Methods
Method: name-map (SCENE-GRAPH scene-graph)

automatically generated reader method

Generic Function: (setf name-map) NEW-VALUE OBJECT
Package

flare

Reader

name-map (generic function)

Methods
Method: (setf name-map) NEW-VALUE (SCENE-GRAPH scene-graph)

automatically generated writer method

Source

container.lisp (file)

Generic Function: objects CONTAINER

Accessor to a value that stores which objects are being managed.

Package

flare

Source

container.lisp (file)

Writer

(setf objects) (generic function)

Methods
Method: objects (LEAVE-OPERATION leave-operation)

automatically generated reader method

Source

change.lisp (file)

Method: objects (ENTER-OPERATION enter-operation)

automatically generated reader method

Source

change.lisp (file)

Method: objects (CONTAINER container)

automatically generated reader method

Generic Function: (setf objects) NEW-VALUE OBJECT
Package

flare

Reader

objects (generic function)

Methods
Method: (setf objects) NEW-VALUE (LEAVE-OPERATION leave-operation)

automatically generated writer method

Source

change.lisp (file)

Method: (setf objects) NEW-VALUE (ENTER-OPERATION enter-operation)

automatically generated writer method

Source

change.lisp (file)

Method: (setf objects) NEW-VALUE (CONTAINER container)

automatically generated writer method

Source

container.lisp (file)

Generic Function: orientation ENTITY

Accessor to the vector that defines the orientation of the entity.

See ORIENTED-ENTITY

Package

flare

Source

forms.lisp (file)

Writer

(setf orientation) (generic function)

Methods
Method: orientation (ORIENTED-ENTITY oriented-entity)

automatically generated reader method

Generic Function: (setf orientation) NEW-VALUE OBJECT
Package

flare

Reader

orientation (generic function)

Methods
Method: (setf orientation) VAL (ARC arc) after
Source

forms.lisp (file)

Method: (setf orientation) NEW-VALUE (ORIENTED-ENTITY oriented-entity)

automatically generated writer method

Source

forms.lisp (file)

Generic Function: original-value OBJECT TWEEN

Returns the original value this object might have had before the given tween changed anything.

See TWEEN

Package

flare

Source

change.lisp (file)

Methods
Method: original-value OBJECT (TWEEN accessor-tween)
Method: original-value OBJECT (TWEEN slot-tween)
Generic Function: originals OBJECT

A hash table to store the original values of objects before they were changed.

Package

flare

Writer

(setf originals) (generic function)

Methods
Method: originals (ACCESSOR-TWEEN accessor-tween)

automatically generated reader method

Source

change.lisp (file)

Method: originals (SLOT-TWEEN slot-tween)

automatically generated reader method

Source

change.lisp (file)

Generic Function: (setf originals) NEW-VALUE OBJECT
Package

flare

Reader

originals (generic function)

Methods
Method: (setf originals) NEW-VALUE (ACCESSOR-TWEEN accessor-tween)

automatically generated writer method

Source

change.lisp (file)

Method: (setf originals) NEW-VALUE (SLOT-TWEEN slot-tween)

automatically generated writer method

Source

change.lisp (file)

Generic Function: paint PAINTABLE TARGET

Performs the necessary painting operations to draw PAINTABLE onto TARGET.

See TARGET
See PAINTABLE

Package

flare

Source

paintable.lisp (file)

Methods
Method: paint PAINTABLE TARGET
Method: paint (CONTAINER container) TARGET
Source

container.lisp (file)

Generic Function: past-animations PROGRESSION

Accessor to the vector of animations that have ended before the current clock time.

See PROGRESSION

Package

flare

Source

animation.lisp (file)

Writer

(setf past-animations) (generic function)

Methods
Method: past-animations (PROGRESSION progression)

automatically generated reader method

Generic Function: (setf past-animations) NEW-VALUE OBJECT
Package

flare

Reader

past-animations (generic function)

Methods
Method: (setf past-animations) NEW-VALUE (PROGRESSION progression)

automatically generated writer method

Source

animation.lisp (file)

Generic Function: present-animations PROGRESSION

Accessor to the vector of currently active animations within the clock time.

See PROGRESSION

Package

flare

Source

animation.lisp (file)

Writer

(setf present-animations) (generic function)

Methods
Method: present-animations (PROGRESSION progression)

automatically generated reader method

Generic Function: (setf present-animations) NEW-VALUE OBJECT
Package

flare

Reader

present-animations (generic function)

Methods
Method: (setf present-animations) NEW-VALUE (PROGRESSION progression)

automatically generated writer method

Source

animation.lisp (file)

Generic Function: progression DENOMINATOR ANIMATABLE

Find all progressions that match the denominator within the container.

Package

flare

Source

animation.lisp (file)

Methods
Method: progression (DEFINITION progression-definition) (ANIMATABLE animatable)
Generic Function: progression-instance PROGRESSION-DEFINITION

Constructs a new progression instance using the given definition.

See PROGRESSION
See PROGRESSION-DEFINITION

Package

flare

Source

animation.lisp (file)

Methods
Method: progression-instance (NAME symbol)
Source

parser.lisp (file)

Method: progression-instance (DEFINITION progression-definition)
Generic Function: progressions ANIMATABLE

Accessor to the list of progressions that act upon this.

See ANIMATABLE

Package

flare

Source

animation.lisp (file)

Writer

(setf progressions) (generic function)

Methods
Method: progressions (ANIMATABLE animatable)

automatically generated reader method

Generic Function: (setf progressions) NEW-VALUE OBJECT
Package

flare

Reader

progressions (generic function)

Methods
Method: (setf progressions) NEW-VALUE (ANIMATABLE animatable)

automatically generated writer method

Source

animation.lisp (file)

Generic Function: register UNIT SCENE-GRAPH

Registers the unit with the scene-graph, making it accessible by its name.
Any unit that is entered into any part of the scene-graph must be registered by this function. This should happen automatically provided you use the CONTAINER-UNIT class for containers inside the scene-graph. Thus you need not call this function unless you implement your own container.

See UNIT
See SCENE-GRAPH

Package

flare

Source

container.lisp (file)

Methods
Method: register (UNIT container-unit) (SCENE-GRAPH scene-graph) after
Method: register (UNIT unit) (SCENE-GRAPH scene-graph)
Method: register (UNIT unit) (SCENE-GRAPH scene-graph) around
Generic Function: remove-progression PROGRESSION ANIMATABLE

Remove an existing progression from animatable.

See PROGRESSION
See ANIMATABLE

Package

flare

Source

animation.lisp (file)

Methods
Method: remove-progression (PROGRESSION progression) (ANIMATABLE animatable)
Generic Function: reset CLOCK

Resets the given clock to its initial state.

Returns the object given.

See CLOCK

Package

flare

Source

clock.lisp (file)

Methods
Method: reset (TWEEN constant-tween) after
Source

change.lisp (file)

Method: reset (TWEEN accessor-tween)
Source

change.lisp (file)

Method: reset (TWEEN slot-tween)
Source

change.lisp (file)

Method: reset (OP leave-operation)
Source

change.lisp (file)

Method: reset (OP enter-operation)
Source

change.lisp (file)

Method: reset (CHANGE change)
Source

change.lisp (file)

Method: reset (ANIMATION animation)
Source

animation.lisp (file)

Method: reset (PROGRESSION progression)
Source

animation.lisp (file)

Method: reset (ANIMATABLE animatable) before
Source

animation.lisp (file)

Method: reset (CLOCK clock)
Method: reset CLOCK around
Generic Function: running CLOCK

Accessor to whether the clock is currently running or not.

See CLOCK

Package

flare

Source

clock.lisp (file)

Writer

(setf running) (generic function)

Methods
Method: running (CLOCK clock)

automatically generated reader method

Generic Function: (setf running) NEW-VALUE OBJECT
Package

flare

Reader

running (generic function)

Methods
Method: (setf running) NEW-VALUE (CLOCK clock)

automatically generated writer method

Source

clock.lisp (file)

Generic Function: scene-graph CONTAINER-UNIT

Accessor to the scene-graph the container-unit is in.

See CONTAINER-UNIT

Package

flare

Source

container.lisp (file)

Writer

(setf scene-graph) (generic function)

Methods
Method: scene-graph (CONTAINER-UNIT container-unit)

automatically generated reader method

Generic Function: (setf scene-graph) NEW-VALUE OBJECT
Package

flare

Reader

scene-graph (generic function)

Methods
Method: (setf scene-graph) (SCENE-GRAPH scene-graph) (UNIT container-unit) after
Source

container.lisp (file)

Method: (setf scene-graph) SCENE-GRAPH (UNIT container-unit) before
Source

container.lisp (file)

Method: (setf scene-graph) NEW-VALUE (CONTAINER-UNIT container-unit)

automatically generated writer method

Source

container.lisp (file)

Generic Function: selector ANIMATION

Accessor to the selector that describes which elements to affect.

See ANIMATION
See COMPILE-SELECTOR

Package

flare

Source

animation.lisp (file)

Writer

(setf selector) (generic function)

Methods
Method: selector (ANIMATION animation)

automatically generated reader method

Generic Function: (setf selector) NEW-VALUE OBJECT
Package

flare

Reader

selector (generic function)

Methods
Method: (setf selector) VALUE (ANIMATION animation)
Source

animation.lisp (file)

Generic Function: size ENTITY

Accessor to the size of the entity.

See SIZED-ENTITY

Package

flare

Source

forms.lisp (file)

Writer

(setf size) (generic function)

Methods
Method: size (SIZED-ENTITY sized-entity)

automatically generated reader method

Generic Function: (setf size) NEW-VALUE OBJECT
Package

flare

Reader

size (generic function)

Methods
Method: (setf size) VAL (ARC arc) after
Source

forms.lisp (file)

Method: (setf size) NEW-VALUE (SIZED-ENTITY sized-entity)

automatically generated writer method

Source

forms.lisp (file)

Generic Function: slot OBJECT

Accessor to the slot that should be modified.

Package

flare

Writer

(setf slot) (generic function)

Methods
Method: slot (SLOT-TWEEN slot-tween)

automatically generated reader method

Source

change.lisp (file)

Generic Function: (setf slot) NEW-VALUE OBJECT
Package

flare

Reader

slot (generic function)

Methods
Method: (setf slot) NEW-VALUE (SLOT-TWEEN slot-tween)

automatically generated writer method

Source

change.lisp (file)

Generic Function: spacing ARC

Accessor to the spacing between items.

See ARC

Package

flare

Source

forms.lisp (file)

Writer

(setf spacing) (generic function)

Methods
Method: spacing (ARC arc)

automatically generated reader method

Generic Function: (setf spacing) NEW-VALUE OBJECT
Package

flare

Reader

spacing (generic function)

Methods
Method: (setf spacing) VAL (ARC arc) after
Source

forms.lisp (file)

Method: (setf spacing) NEW-VALUE (ARC arc)

automatically generated writer method

Source

forms.lisp (file)

Generic Function: start CLOCK

Starts the given clock.

Returns the object given.

See CLOCK

Package

flare

Source

clock.lisp (file)

Writer

(setf start) (generic function)

Methods
Method: start (SCENE scene) after
Source

scene.lisp (file)

Method: start (CONSTANT-TWEEN constant-tween)

automatically generated reader method

Source

change.lisp (file)

Method: start (CLOCK clock)
Method: start (CLOCK clock) around
Generic Function: (setf start) NEW-VALUE OBJECT
Package

flare

Reader

start (generic function)

Methods
Method: (setf start) NEW-VALUE (CONSTANT-TWEEN constant-tween)

automatically generated writer method

Source

change.lisp (file)

Generic Function: stop CLOCK

Stops the given clock.

Returns the object given.

See CLOCK

Package

flare

Source

clock.lisp (file)

Methods
Method: stop (CLOCK clock)
Method: stop (CLOCK clock) around
Generic Function: synchronize CLOCK NEW

Synchronize the clock to the new time.

Time should be another clock or seconds.

Returns the object given.

See CLOCK

Package

flare

Source

clock.lisp (file)

Methods
Method: synchronize (CLOCK clock) (WITH real)
Method: synchronize (CLOCK clock) (WITH clock)
Method: synchronize CLOCK NEW around
Generic Function: tick ANIMATION ANIMATABLE CLOCK STEP

Performs a single update tick, moving along the animation on the animatable at the given clock for the given step amount of time.

See ANIMATION
See ANIMATABLE
See CLOCK

Package

flare

Source

animation.lisp (file)

Methods
Method: tick (TWEEN accessor-tween) OBJECT CLOCK STEP
Source

change.lisp (file)

Method: tick (TWEEN slot-tween) OBJECT CLOCK STEP
Source

change.lisp (file)

Method: tick (OP leave-operation) OBJECT CLOCK STEP
Source

change.lisp (file)

Method: tick (OP enter-operation) TARGET CLOCK STEP
Source

change.lisp (file)

Method: tick (CHANGE call-change) OBJECT CLOCK STEP
Source

change.lisp (file)

Method: tick (CHANGE print-change) OBJECT CLOCK STEP
Source

change.lisp (file)

Method: tick (ANIMATION animation) (ANIMATABLE animatable) CLOCK STEP
Generic Function: timescale CLOCK

Accessor to the timescale of the clock to allow slowing or speeding up the progression of time.

See CLOCK

Package

flare

Source

clock.lisp (file)

Writer

(setf timescale) (generic function)

Methods
Method: timescale (CLOCK clock)

automatically generated reader method

Generic Function: (setf timescale) NEW-VALUE OBJECT
Package

flare

Reader

timescale (generic function)

Methods
Method: (setf timescale) NEW-VALUE (CLOCK clock)

automatically generated writer method

Source

clock.lisp (file)

Generic Function: unit NAME SCENE-GRAPH

Accessor to a given, named unit in the scene-graph.

See UNIT
See SCENE-GRAPH

Package

flare

Source

container.lisp (file)

Writer

(setf unit) (generic function)

Methods
Method: unit (NAME symbol) (SCENE-GRAPH scene-graph)
Method: unit N (CONTAINER container)
Generic Function: (setf unit) VALUE N CONTAINER
Package

flare

Reader

unit (generic function)

Methods
Method: (setf unit) VALUE N (CONTAINER container)
Source

container.lisp (file)

Generic Function: units SCENE-GRAPH

Returns a fresh list of all units in the scene-graph tree.

See UNIT
See SCENE-GRAPH

Package

flare

Source

container.lisp (file)

Methods
Method: units (SCENE-GRAPH scene-graph)
Generic Function: up ARC

Accessor to the UP vector.

See ARC

Package

flare

Source

forms.lisp (file)

Writer

(setf up) (generic function)

Methods
Method: up (ARC arc)

automatically generated reader method

Generic Function: (setf up) NEW-VALUE OBJECT
Package

flare

Reader

up (generic function)

Methods
Method: (setf up) VAL (ARC arc) after
Source

forms.lisp (file)

Method: (setf up) NEW-VALUE (ARC arc)

automatically generated writer method

Source

forms.lisp (file)

Generic Function: update OBJECT

Updates the given object, causing its internal representation to be adapted for the current time.

Returns the object given.

Package

flare

Source

clock.lisp (file)

Methods
Method: update (PROGRESSION progression)
Source

animation.lisp (file)

Method: update (ANIMATABLE animatable) after
Source

animation.lisp (file)

Method: update (CONTAINER container)
Source

container.lisp (file)

Method: update (CLOCK clock) around
Method: update (CLOCK clock) before
Method: update OBJECT around
Method: update OBJECT
Generic Function: visibility PAINTABLE

Accessor to how opaque the paintable is. Has to be a float between 0 and 1.

See PAINTABLE

Package

flare

Source

paintable.lisp (file)

Writer

(setf visibility) (generic function)

Methods
Method: visibility (PAINTABLE paintable)

automatically generated reader method

Generic Function: (setf visibility) NEW-VALUE OBJECT
Package

flare

Reader

visibility (generic function)

Methods
Method: (setf visibility) NEW-VALUE (PAINTABLE paintable)

automatically generated writer method

Source

paintable.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Structures

Structure: cell ()

Struct to contain a queue cell with VALUE, LEFT, and RIGHT slots.

See VALUE
See LEFT
See RIGHT

Package

flare-queue

Source

queue.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

print-object (method)

Direct slots
Slot: value
Readers

value (function)

Writers

(setf value) (function)

Slot: left
Readers

left (function)

Writers

(setf left) (function)

Slot: right
Readers

right (function)

Writers

(setf right) (function)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Classes

Class: animatable ()

Superclass container for anything that is animatable through progressions.

See PROGRESSIONS

Package

flare

Source

animation.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: progressions
Readers

progressions (generic function)

Writers

(setf progressions) (generic function)

Class: animation ()

A representation for a single set of changes in a progression.

When an animation is ticked, the following happens:
1. The selector is called with the given animatable and a function 2. Once the selector calls its function with a matching object, each change in the animation is ticked with the matching object as argument.

When an animation is reset, each change in the animation is also reset. This should cause whatever effect it might have had to be restored on the scene. This is particularly tricky for operations as they need to ensure the scene stays consistent.

See START
See DURATION
See SELECTOR
See CHANGES

Package

flare

Source

animation.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: defindex
Initargs

:defindex

Readers

defindex (generic function)

Writers

(setf defindex) (generic function)

Slot: beginning
Initargs

:beginning

Readers

beginning (generic function)

Writers

(setf beginning) (generic function)

Slot: duration
Initargs

:duration

Readers

duration (generic function)

Writers

(setf duration) (generic function)

Slot: selector
Initargs

:selector

Readers

selector (generic function)

Writers

(setf selector) (generic function)

Slot: changes
Initargs

:changes

Readers

changes (generic function)

Writers

(setf changes) (generic function)

Direct Default Initargs
InitargValue
:defindex0
:beginning(error "beginning needed.")
:duration(error "duration needed.")
:selectort
:changesnil
Class: arc ()

Formation to represent an equidistant distribution of entities along an arc.

See FORMATION
See ORIENTED-ENTITY
See SIZED-ENTITY
See UP
See TANGENT
See ANGLE
See SPACING

Package

flare

Source

forms.lisp (file)

Direct superclasses
Direct subclasses

ring (class)

Direct methods
Direct slots
Slot: up
Initargs

:up

Readers

up (generic function)

Writers

(setf up) (generic function)

Slot: tangent
Readers

tangent (generic function)

Writers

(setf tangent) (generic function)

Slot: angle
Initargs

:angle

Readers

angle (generic function)

Writers

(setf angle) (generic function)

Slot: spacing
Initargs

:spacing

Readers

spacing (generic function)

Writers

(setf spacing) (generic function)

Direct Default Initargs
InitargValue
:up(3d-vectors:vec 0 0 1)
:angle0
:spacing10
:size0
Class: call-accessor-tween ()

Combination of a call-change and an accessor-tween.

Creation: (calc accessor :to form)
The FORM may use the implicit variables OBJECT, CLOCK, and STEP.

Implements TWEEN-VALUE.

See CALL-CHANGE
See SLOT-TWEEN
See TWEEN-VALUE

Package

flare

Source

change.lisp (file)

Direct superclasses
Direct methods

tween-value (method)

Class: call-change ()

A change that calls a specified function on every tick.
The function is called with the OBJECT, CLOCK, and STEP received from TICK.

Creation: (call :func tick-function)

See CHANGE
See FUNC
See TICK

Package

flare

Source

change.lisp (file)

Direct superclasses

change (class)

Direct subclasses
Direct methods
Direct slots
Slot: func
Initargs

:func

Readers

func (generic function)

Writers

(setf func) (generic function)

Class: call-slot-tween ()

Combination of a call-change and a slot-tween.

Implements TWEEN-VALUE.

See CALL-CHANGE
See SLOT-TWEEN
See TWEEN-VALUE

Package

flare

Source

change.lisp (file)

Direct superclasses
Direct methods

tween-value (method)

Class: change ()

Container for a single change or tween within an animation.

Package

flare

Source

change.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Class: clock ()

A representation for an item that changes its state over time.

Keeps its own time information in seconds.

See START
See STOP
See RESET
See RUNNING
See UPDATE
See SNYCHRONIZE
See CLOCK
See PREVIOUS-TIME

Package

flare

Source

clock.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: previous-time
Initform

(get-internal-real-time)

Readers

previous-time (generic function)

Writers

(setf previous-time) (generic function)

Slot: clock
Initargs

:clock

Readers

clock (generic function)

Writers

(setf clock) (generic function)

Slot: running
Initargs

:running

Readers

running (generic function)

Writers

(setf running) (generic function)

Slot: timescale
Initargs

:timescale

Readers

timescale (generic function)

Writers

(setf timescale) (generic function)

Direct Default Initargs
InitargValue
:clock0.0
:timescale1.0
:runningnil
Class: constant-tween ()

A tween mixin that simply increases a value every tick.

Implements TWEEN-VALUE
Default BY and FOR are 1.

See TWEEN
See BY
See FOR
See START

Package

flare

Source

change.lisp (file)

Direct superclasses

tween (class)

Direct subclasses
Direct methods
Direct slots
Slot: by
Initargs

:by

Readers

by (generic function)

Writers

(setf by) (generic function)

Slot: for
Initargs

:for

Readers

for (generic function)

Writers

(setf for) (generic function)

Slot: start
Readers

start (generic function)

Writers

(setf start) (generic function)

Direct Default Initargs
InitargValue
:by1
:for1
Class: container ()

A simple class that can hold a set of objects.

See CLEAR
See OBJECTS
See ENTER
See LEAVE
See MAP-CONTAINER-TREE
See DO-CONTAINER-TREE
See PRINT-CONTAINER-TREE

Package

flare

Source

container.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: objects
Initform

(flare-indexed-set:make-indexed-set)

Readers

objects (generic function)

Writers

(setf objects) (generic function)

Class: container-unit ()

A container unit is a unit that can contain further objects.

See CONTAINER
See UNIT

Package

flare

Source

container.lisp (file)

Direct superclasses
Direct subclasses

entity (class)

Direct methods
Direct slots
Slot: scene-graph
Readers

scene-graph (generic function)

Writers

(setf scene-graph) (generic function)

Class: enter-operation ()

Represents an operation that introduces new objects into the scene graph.

Creation: (enter class :n number-of-copies :children child-forms :parent parent init-args..) Child-forms being a list of enter forms, excluding the ENTER symbol at the start.
init-args being further initialisation arguments to be passed to the class that’s being instantiated.

Upon TICK, the CREATOR function is executed and each resulting object is ENTERed into the
given target animatable.

See OPERATION
See OBJECTS
See CREATOR

Package

flare

Source

change.lisp (file)

Direct superclasses

operation (class)

Direct methods
Direct slots
Slot: objects
Initform

(make-hash-table :test (quote eq))

Readers

objects (generic function)

Writers

(setf objects) (generic function)

Slot: creator
Initargs

:creator

Readers

creator (generic function)

Writers

(setf creator) (generic function)

Class: entity ()

A paintable and animatable entity within a scene.

See CONTAINER-UNIT
See PAINTABLE
See ANIMATABLE
See LOCATION

Package

flare

Source

scene.lisp (file)

Direct superclasses
Direct subclasses
Direct methods
Direct slots
Slot: location
Initargs

:location

Readers

location (generic function)

Writers

(setf location) (generic function)

Direct Default Initargs
InitargValue
:location(3d-vectors:vec 0 0 0)
Class: formation ()

Entity superclass for all formations.

Formations only handle the positioning of child entities, but do not display by themselves.

See ENTITY

Package

flare

Source

forms.lisp (file)

Direct superclasses

entity (class)

Direct subclasses

arc (class)

Direct methods
Class: increase-slot-tween ()

Combination of a constant-tween and a slot-tween.

See CONSTANT-TWEEN
See SLOT-TWEEN

Package

flare

Source

change.lisp (file)

Direct superclasses
Class: indexed-set ()

A set in which each element also has an index.

Aside from MAP-SET and DO-SET you can also use ITERATE to go through the set by FOR .. ON-SET or FOR .. IN-SET.

See QUEUE
See SET
See MAKE-INDEXED-SET
See MAP-SET
See DO-SET
See SET-ADD
See SET-REMOVE
See SET-SIZE
See SET-FIRST
See SET-LAST
See SET-VALUE-AT
See SET-INDEX-OF
See CLEAR-SET
See IN-SET-P
See COERCE-SET

Package

flare-indexed-set

Source

indexed-set.lisp (file)

Direct superclasses

queue (class)

Direct methods
  • set (method)
  • set (method)
Direct slots
Slot: set
Initform

(make-hash-table :test (quote eql))

Readers

set (generic function)

Writers

(setf set) (generic function)

Class: leave-operation ()

Represents an operation that removes objects from the scene graph.

Creation: (leave)

Upon TICK, the given animatable is removed from its parents by LEAVE.

See OPERATION
See OBJECTS

Package

flare

Source

change.lisp (file)

Direct superclasses

operation (class)

Direct methods
Direct slots
Slot: objects
Initform

(make-hash-table :test (quote eq))

Readers

objects (generic function)

Writers

(setf objects) (generic function)

Class: operation ()

Superclass for changes that modify the scene graph by adding, removing, or moving elements within it.

See CHANGE

Package

flare

Source

change.lisp (file)

Direct superclasses

change (class)

Direct subclasses
Class: oriented-entity ()

An entity that can be oriented by a vector.

See ENTITY
See ORIENTATION

Package

flare

Source

forms.lisp (file)

Direct superclasses

entity (class)

Direct subclasses

arc (class)

Direct methods
Direct slots
Slot: orientation
Initargs

:orientation

Readers

orientation (generic function)

Writers

(setf orientation) (generic function)

Direct Default Initargs
InitargValue
:orientation(3d-vectors:vec 1 0 0)
Class: paintable ()

Superclass for anything that may be painted onto a target.

See PAINT
See TARGET

Package

flare

Source

paintable.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: visibility
Initargs

:visibility

Readers

visibility (generic function)

Writers

(setf visibility) (generic function)

Direct Default Initargs
InitargValue
:visibility1.0
Class: particle ()

Entity superclass for all particles.

Particles should not move by themselves and only handle the displaying.

See ENTITY

Package

flare

Source

forms.lisp (file)

Direct superclasses

entity (class)

Class: print-change ()

A NO-OP change that simply prints its TICK arguments when called. Useful for debugging.

Creation: (print)

See CHANGE
See TICK

Package

flare

Source

change.lisp (file)

Direct superclasses

change (class)

Direct methods

tick (method)

Class: progression ()

The controller to animate an animatable with.

Contains an entire sequence of animations and controls their behaviour and effects on the animatable.

When animations on the progression are set, the following happens: 1. The current clock is saved.
2. The progression is reset.
3. The new animations are set to the future set and sorted, the other sets are cleared and reinitialised to match the appropriate length. 4. The clock is set to the previously saved time.
5. All applicable animations are put into effect in fast-forwarding by calling UPDATE on the progression.

When a progression is reset, the following happens:
1. All past animations are pushed onto the present set.
2. The active animations are re-sorted to ensure consistency.
3. All the animations in the present set are reset in order.
4. All animations are pushed onto the future set.
5. The clock is fixed.

When a progression is updated, the following happens:
1. New animations that are now active during the current clock are shifted from the future set to the present set.
2. When the progression has an animatable, each animation is ticked. For this, the tick step must be calculated. If the duration of the animation is infinite, the tick is T. If the animation exceeded its duration, it is 1.0. Otherwise it is the linear interpolation between the current clock time, the beginning of the animation, and its duration.
3. Animations that have exceeded their duration are shifted from the present set onto the past set.
4. If no present or future animations remain, the progression stops itself.

See CLOCK
See DEFINITION
See ANIMATABLE
See ACTIVE
See ENDED
See FUTURE

Package

flare

Source

animation.lisp (file)

Direct superclasses

clock (class)

Direct methods
Direct slots
Slot: definition
Initargs

:definition

Readers

definition (generic function)

Writers

(setf definition) (generic function)

Slot: animatable
Initargs

:animatable

Readers

animatable (generic function)

Writers

(setf animatable) (generic function)

Slot: active
Initform

#()

Readers

present-animations (generic function)

Writers

(setf present-animations) (generic function)

Slot: ended
Initform

#()

Readers

past-animations (generic function)

Writers

(setf past-animations) (generic function)

Slot: future
Initform

#()

Readers

future-animations (generic function)

Writers

(setf future-animations) (generic function)

Direct Default Initargs
InitargValue
:animatablenil
:definition(error "definition required.")
Class: progression-definition ()

Container class to instantiate a progression from.

The definition should at all time keep track of the existing instances and update them in case the definition gets updated with new animations. When the animations of the definition are set, the animations are also set for each of the known instances of the definition.

See ANIMATIONS
See INSTANCES

Package

flare

Source

animation.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: animations
Initform

(make-array 0)

Readers

animations (generic function)

Writers

(setf animations) (generic function)

Slot: instances
Readers

instances (generic function)

Writers

(setf instances) (generic function)

Class: queue ()

Implements an ordered queue.

Aside from MAP-QUEUE and DO-QUEUE you can also use ITERATE to go through the set by FOR .. ON-QUEUE or FOR .. IN-QUEUE.

See HEAD
See TAIL
See SIZE
See MAP-QUEUE
See DO-QUEUE
See ENQUEUE
See DEQUEUE
See QUEUE-REMOVE
See QUEUE-SIZE
See QUEUE-FIRST
See QUEUE-LAST
See QUEUE-VALUE-AT
See QUEUE-INDEX-OF
See CLEAR-QUEUE
See IN-QUEUE-P
See COERCE-QUEUE

Package

flare-queue

Source

queue.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

indexed-set (class)

Direct methods
  • make-iterator (method)
  • print-object (method)
  • initialize-instance (method)
  • set-size (method)
  • size (method)
  • tail (method)
  • tail (method)
  • head (method)
  • head (method)
Direct slots
Slot: head
Initform

(flare-queue::make-cell nil nil nil)

Readers

head (generic function)

Writers

(setf head) (generic function)

Slot: tail
Initform

(flare-queue::make-cell nil nil nil)

Readers

tail (generic function)

Writers

(setf tail) (generic function)

Slot: size
Initform

0

Readers

size (generic function)

Writers

set-size (generic function)

Class: range-slot-tween ()

Combination of a range-tween and a slot-tween.

See RANGE-TWEEN
See SLOT-TWEEN

Package

flare

Source

change.lisp (file)

Direct superclasses
Class: range-tween ()

A tween mixin that interpolates a given range of values using an easing function.

Implements TWEEN-VALUE
Default FROM is 0, TO is 1, and EASE is LINEAR.

See TWEEN
See FROM
See TO
See EASE-FUNC
See *EASINGS*

Package

flare

Source

change.lisp (file)

Direct superclasses

tween (class)

Direct subclasses
Direct methods
Direct slots
Slot: from
Initargs

:from

Readers

from (generic function)

Writers

(setf from) (generic function)

Slot: to
Initargs

:to

Readers

to (generic function)

Writers

(setf to) (generic function)

Slot: ease-func
Initargs

:ease

Readers

ease-func (generic function)

Writers

(setf ease-func) (generic function)

Direct Default Initargs
InitargValue
:fromnil
:to1
:ease(quote flare:linear)
Class: ring ()

Formation to represent an equidistant distribution of entities along a ring.

See ARC

Package

flare

Source

forms.lisp (file)

Direct superclasses

arc (class)

Direct methods

reposition (method)

Class: scene ()

Container class to represent the top-level scene that should be drawn and managed.

See SCENE-GRAPH
See CLOCK
See PAINTABLE
See ANIMATABLE

Package

flare

Source

scene.lisp (file)

Direct superclasses
Direct methods

start (method)

Class: scene-graph ()

A scene-graph is a container that also has a name-map to easily reach objects. This includes all objects in the container tree.

See CONTAINER

Package

flare

Source

container.lisp (file)

Direct superclasses

container (class)

Direct subclasses

scene (class)

Direct methods
Direct slots
Slot: name-map
Initform

(make-hash-table :test (quote eq))

Readers

name-map (generic function)

Writers

(setf name-map) (generic function)

Class: sized-entity ()

An entity that has a given size or extent.

See ENTITY
See SIZE

Package

flare

Source

forms.lisp (file)

Direct superclasses

entity (class)

Direct subclasses

arc (class)

Direct methods
Direct slots
Slot: size
Initargs

:size

Readers

size (generic function)

Writers

(setf size) (generic function)

Direct Default Initargs
InitargValue
:size1.0
Class: slot-tween ()

A tween mixin that modifies a slot on the object.

Upon TICK the slot-value is set with the result of TWEEN-VALUE.

See TWEEN
See SLOT
See ORIGINALS
See TWEEN-VALUE

Package

flare

Source

change.lisp (file)

Direct superclasses

tween (class)

Direct subclasses
Direct methods
Direct slots
Slot: slot
Initargs

:slot

Readers

slot (generic function)

Writers

(setf slot) (generic function)

Slot: originals
Initform

(make-hash-table :test (quote eq))

Readers

originals (generic function)

Writers

(setf originals) (generic function)

Class: target ()

Superclass for a painting device onto which things can be drawn.

See PAINT
See CALL-WITH-TRANSLATION

Package

flare

Source

paintable.lisp (file)

Direct superclasses

standard-object (class)

Class: tween ()

Superclass for changes that modify the given animatable, but do not change the scene graph.

See CHANGE

Package

flare

Source

change.lisp (file)

Direct superclasses

change (class)

Direct subclasses
Class: unit ()

A unit is an object with a name.

Package

flare

Source

container.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

container-unit (class)

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name (generic function)

Direct Default Initargs
InitargValue
:name(gensym "")

Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *animation-defindex*
Package

flare

Source

parser.lisp (file)

Special Variable: *ease-docs*

A hash table associating names to easing function docstrings.

Package

flare

Source

easings.lisp (file)

Special Variable: *easings*

A hash table associating names to easing functions.

Each easing function takes a single float value between 0 and 1 that should be eased according to a curve.

Package

flare

Source

easings.lisp (file)

Special Variable: *i*

A counter variable used to determine the current index in constraints.

Package

flare

Source

parser.lisp (file)

Special Variable: *mapper*

A placeholder variable used to hold the final mapping function upon selector evaluation.

Package

flare

Source

parser.lisp (file)

Special Variable: *progressions*

Hash table to contain global progression definitions.

Package

flare

Source

parser.lisp (file)

Special Variable: *resetting*

A kludge variable used to prevent recursion upon a progression reset.

Package

flare

Source

animation.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

Macro: compile-animations &body INTERVALS

Compiles INTERVAL definition expressions into a list of animation definition forms.

First normalises the intervals per PARSE-INTERVALS then creates a form for each per PARSE-ANIMATION and outputs each into a LIST form.

See DEFINE-PROGRESSION

Package

flare

Source

parser.lisp (file)

Macro: compile-change TYPE &rest ARGS

Simply calls PARSE-CHANGE

Package

flare

Source

parser.lisp (file)

Macro: define-self-returning-method NAME ARGLIST

Shorthand to define an :around method that will ensure the first argument is always returned.

Package

flare

Source

toolkit.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: animation< A B
Package

flare

Source

animation.lisp (file)

Function: animation> A B
Package

flare

Source

animation.lisp (file)

Function: compile-constraint CONSTRAINT NEXT

Compile a selector constraint into a function.

constraint ::= name | nth | this | children | everything | function | list
name — A keyword naming a unit in the scene-graph
nth — An integer specifying the nth unit in the scene-graph
this — The symbol T meaning the current object
children — A symbol with name ">" specifying all children of the current object everything — A symbol with name "*" specifying all descendants as per DO-CONTAINER-TREE function — A predicate function that is passed the current object
list — A quoted literal, function reference, or function form to use

Resulting from a compile-constraint call should be a function
that takes a single argument, the current object to constrain on.
The NEXT argument is the function to call next if the constraint
passes its test. A single constraint may call this next function
as many times as it wants.

Package

flare

Source

parser.lisp (file)

Function: compile-selector SELECTOR

Compiles a selector into a function.

selector ::= constraint | (constraint*)

Returned is a function of two arguments, a scene-graph and a function. The scene-graph is the root of the scene graph that is selected on and each unit within it that the selector is matching on results in a call to function with that unit as its argument.

See COMPILE-CONSTRAINT

Package

flare

Source

parser.lisp (file)

Function: copy-animations THING

Create a copy of the given sequence of animations.

Calls COPY on each animation.

Package

flare

Source

animation.lisp (file)

Function: designator-p THING

Returns T if the given THING is an interval-designator.

See INTERVAL-DESIGNATOR

Package

flare

Source

parser.lisp (file)

Function: ensure-sorted VEC SORTING &key KEY

Ensures that the VEC is sorted stably in-place.

This means that if STABLE-SORT returns a new vector instead of re-using the given one, the elements from the new vector are copied back into the old one so that it appears as if it had been modified in-place. Always returns VEC.

See STBLE-SORT

Package

flare

Source

toolkit.lisp (file)

Function: format-progression PROGR

Print the progression in a usable manner to inspect its current state. Useful for debugging

See PROGRESSION

Package

flare

Source

animation.lisp (file)

Function: make-cell VALUE LEFT RIGHT

Constructs a new queue cell.

See CELL

Package

flare-queue

Source

queue.lisp (file)

Function: parse-animation BEGINNING DURATION EXPRESSION

Compiles BEGINNING, DURATION, and the definition EXPRESSION into an actual FORM.

expression ::= (selector change*)

See COMPILE-CHANGE
See DEFINE-PROGRESSION

Package

flare

Source

parser.lisp (file)

Function: parse-intervals FORMS

Normalises the lenient interval FORMS into strict expressions.

result ::= (expression*)
expression ::= (start duration animation-expression)

See DEFINE-PROGRESSION

Package

flare

Source

parser.lisp (file)

Function: shift-array-elements FROM TO TEST

Moves elements from FROM to TO if they pass TEST.

Elements are actively removed from FROM and inserted into TO

See ARRAY-UTILS:VECTOR-POP-POSITION
See CL:VECTOR-PUSH

Package

flare

Source

animation.lisp (file)

Function: simulate-progression DEF

Simulates running the progression-definition.

Creates a new scene instance and progression instance, starts both of those and then updates the scene, printing the progression each 0.7 seconds.

See SCENE
See PROGRESSION-INSTANCE
See UPDATE
See FORMAT-PROGRESSION

Package

flare

Source

animation.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Generic functions

Generic Function: accessor OBJECT

Accessor to the accessor that should be used to modify an object.

Package

flare

Writer

(setf accessor) (generic function)

Methods
Method: accessor (ACCESSOR-TWEEN accessor-tween)

automatically generated reader method

Source

change.lisp (file)

Generic Function: (setf accessor) NEW-VALUE OBJECT
Package

flare

Reader

accessor (generic function)

Methods
Method: (setf accessor) NEW-VALUE (ACCESSOR-TWEEN accessor-tween)

automatically generated writer method

Source

change.lisp (file)

Generic Function: by OBJECT

The step by which to increase each unit.

See CONSTANT-TWEEN

Package

flare

Writer

(setf by) (generic function)

Methods
Method: by (CONSTANT-TWEEN constant-tween)

automatically generated reader method

Source

change.lisp (file)

Generic Function: (setf by) NEW-VALUE OBJECT
Package

flare

Reader

by (generic function)

Methods
Method: (setf by) NEW-VALUE (CONSTANT-TWEEN constant-tween)

automatically generated writer method

Source

change.lisp (file)

Generic Function: copy ANIMATION

Create a copy of the given item in a way that is deemed appropriate for it. Mostly used for copying changes.

Package

flare

Source

animation.lisp (file)

Methods
Method: copy (TWEEN constant-tween)
Source

change.lisp (file)

Method: copy (TWEEN range-tween)
Source

change.lisp (file)

Method: copy (TWEEN accessor-tween)
Source

change.lisp (file)

Method: copy (TWEEN slot-tween)
Source

change.lisp (file)

Method: copy (OP enter-operation)
Source

change.lisp (file)

Method: copy (CHANGE call-change) around
Source

change.lisp (file)

Method: copy (CHANGE change)
Source

change.lisp (file)

Method: copy (ANIMATION animation)
Generic Function: defindex OBJECT
Generic Function: (setf defindex) NEW-VALUE OBJECT
Package

flare

Methods
Method: defindex (ANIMATION animation)

automatically generated reader method

Source

animation.lisp (file)

Method: (setf defindex) NEW-VALUE (ANIMATION animation)

automatically generated writer method

Source

animation.lisp (file)

Generic Function: definition OBJECT

Accessor to the progression’s progression-definition

See PROGRESSION

Package

flare

Writer

(setf definition) (generic function)

Methods
Method: definition (PROGRESSION progression)

automatically generated reader method

Source

animation.lisp (file)

Generic Function: (setf definition) NEW-VALUE OBJECT
Package

flare

Reader

definition (generic function)

Methods
Method: (setf definition) NEW-VALUE (PROGRESSION progression)

automatically generated writer method

Source

animation.lisp (file)

Generic Function: ease-func OBJECT

Accessor to the easing function to be used to interpolate the value range.

See RANGE-TWEEN

Package

flare

Writer

(setf ease-func) (generic function)

Methods
Method: ease-func (RANGE-TWEEN range-tween)

automatically generated reader method

Source

change.lisp (file)

Generic Function: (setf ease-func) NEW-VALUE OBJECT
Package

flare

Reader

ease-func (generic function)

Methods
Method: (setf ease-func) NEW-VALUE (RANGE-TWEEN range-tween)

automatically generated writer method

Source

change.lisp (file)

Generic Function: for OBJECT

The time step (in seconds) in which the value is increased by a single BY unit.

See CONSTANT-TWEEN

Package

flare

Writer

(setf for) (generic function)

Methods
Method: for (CONSTANT-TWEEN constant-tween)

automatically generated reader method

Source

change.lisp (file)

Generic Function: (setf for) NEW-VALUE OBJECT
Package

flare

Reader

for (generic function)

Methods
Method: (setf for) NEW-VALUE (CONSTANT-TWEEN constant-tween)

automatically generated writer method

Source

change.lisp (file)

Generic Function: from OBJECT

Accessor to the beginning value.

See RANGE-TWEEN

Package

flare

Writer

(setf from) (generic function)

Methods
Method: from (RANGE-TWEEN range-tween)

automatically generated reader method

Source

change.lisp (file)

Generic Function: (setf from) NEW-VALUE OBJECT
Package

flare

Reader

from (generic function)

Methods
Method: (setf from) NEW-VALUE (RANGE-TWEEN range-tween)

automatically generated writer method

Source

change.lisp (file)

Generic Function: func OBJECT

Accessor to the function container slot.

Package

flare

Writer

(setf func) (generic function)

Methods
Method: func (CALL-CHANGE call-change)

automatically generated reader method

Source

change.lisp (file)

Generic Function: (setf func) NEW-VALUE OBJECT
Package

flare

Reader

func (generic function)

Methods
Method: (setf func) NEW-VALUE (CALL-CHANGE call-change)

automatically generated writer method

Source

change.lisp (file)

Generic Function: head OBJECT

Accesses the head cell of the queue

See CELL
See QUEUE

Package

flare-queue

Writer

(setf head) (generic function)

Methods
Method: head (QUEUE queue)

automatically generated reader method

Source

queue.lisp (file)

Generic Function: (setf head) NEW-VALUE OBJECT
Package

flare-queue

Reader

head (generic function)

Methods
Method: (setf head) NEW-VALUE (QUEUE queue)

automatically generated writer method

Source

queue.lisp (file)

Generic Function: insert FORMATION &rest OBJS
Package

flare

Methods
Method: insert (FORMATION formation) &rest OBJS after
Source

forms.lisp (file)

Generic Function: parse-change TYPE ARGS

Parse a change definition form that gives the TYPE and ARGS into an evaluatable form.

Package

flare

Source

change.lisp (file)

Methods
Method: parse-change (G1 (eql calc)) FORM0
Method: parse-change (G1 (eql increase)) FORM0
Method: parse-change (G1 (eql set)) FORM0
Method: parse-change (G1 (eql leave)) FORM0
Method: parse-change (G1 (eql enter)) FORM0
Method: parse-change (G1 (eql create)) FORM0
Method: parse-change (G1 (eql call)) FORM0
Method: parse-change (G1 (eql print)) FORM0
Generic Function: previous-time OBJECT

Accessor to the previous internal-real-time when the clock was updated.

See CLOCK

Package

flare

Writer

(setf previous-time) (generic function)

Methods
Method: previous-time (CLOCK clock)

automatically generated reader method

Source

clock.lisp (file)

Generic Function: (setf previous-time) NEW-VALUE OBJECT
Package

flare

Reader

previous-time (generic function)

Methods
Method: (setf previous-time) NEW-VALUE (CLOCK clock)

automatically generated writer method

Source

clock.lisp (file)

Generic Function: reposition FORMATION

Recalculate the positioning of child entities.

Package

flare

Source

forms.lisp (file)

Methods
Method: reposition (RING ring) before
Method: reposition (ARC arc)
Generic Function: set OBJECT

Accessor to the set table of the indexed-set.

See INDEXED-SET

Package

flare-indexed-set

Writer

(setf set) (generic function)

Methods
Method: set (INDEXED-SET indexed-set)

automatically generated reader method

Source

indexed-set.lisp (file)

Generic Function: (setf set) NEW-VALUE OBJECT
Package

flare-indexed-set

Reader

set (generic function)

Methods
Method: (setf set) NEW-VALUE (INDEXED-SET indexed-set)

automatically generated writer method

Source

indexed-set.lisp (file)

Generic Function: set-size NEW-VALUE OBJECT
Package

flare-queue

Methods
Method: set-size NEW-VALUE (QUEUE queue)

automatically generated writer method

Source

queue.lisp (file)

Generic Function: size OBJECT

Accesses the size counter of the queue.

See QUEUE

Package

flare-queue

Methods
Method: size (QUEUE queue)

automatically generated reader method

Source

queue.lisp (file)

Generic Function: tail OBJECT

Accesses the tail cell of the queue

See CELL
See QUEUE

Package

flare-queue

Writer

(setf tail) (generic function)

Methods
Method: tail (QUEUE-ITERATOR queue-iterator)

automatically generated reader method

Source

queue.lisp (file)

Method: tail (QUEUE queue)

automatically generated reader method

Source

queue.lisp (file)

Generic Function: (setf tail) NEW-VALUE OBJECT
Package

flare-queue

Reader

tail (generic function)

Methods
Method: (setf tail) NEW-VALUE (QUEUE-ITERATOR queue-iterator)

automatically generated writer method

Source

queue.lisp (file)

Method: (setf tail) NEW-VALUE (QUEUE queue)

automatically generated writer method

Source

queue.lisp (file)

Generic Function: tangent OBJECT

The tangent vector between the UP and ORIENTATION.

See ARC

Package

flare

Writer

(setf tangent) (generic function)

Methods
Method: tangent (ARC arc)

automatically generated reader method

Source

forms.lisp (file)

Generic Function: (setf tangent) NEW-VALUE OBJECT
Package

flare

Reader

tangent (generic function)

Methods
Method: (setf tangent) NEW-VALUE (ARC arc)

automatically generated writer method

Source

forms.lisp (file)

Generic Function: to OBJECT

Accessor to the ending value.

See RANGE-TWEEN

Package

flare

Writer

(setf to) (generic function)

Methods
Method: to (RANGE-TWEEN range-tween)

automatically generated reader method

Source

change.lisp (file)

Generic Function: (setf to) NEW-VALUE OBJECT
Package

flare

Reader

to (generic function)

Methods
Method: (setf to) NEW-VALUE (RANGE-TWEEN range-tween)

automatically generated writer method

Source

change.lisp (file)

Generic Function: tween-value TWEEN OBJECT CLOCK STEP

Computes the currently applicable value for the given tween, object, clock, and stepping time.

See TWEEN

Package

flare

Source

change.lisp (file)

Methods
Method: tween-value (TWEEN call-accessor-tween) OBJECT CLOCK STEP
Method: tween-value (TWEEN call-slot-tween) OBJECT CLOCK STEP
Method: tween-value (TWEEN constant-tween) OBJECT CLOCK STEP
Method: tween-value (TWEEN range-tween) OBJECT CLOCK STEP
Generic Function: withdraw FORMATION &rest OBJS
Package

flare

Methods
Method: withdraw (FORMATION formation) &rest OBJS after
Source

forms.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Classes

Class: accessor-tween ()

A tween mixin that modifies an object through an accessor.

Upon TICK the corresponding setf function is called with the result of TWEEN-VALUE.

See TWEEN
See ACCESSOR
See ORIGINALS
See TWEEN-VALUE

Package

flare

Source

change.lisp (file)

Direct superclasses

tween (class)

Direct subclasses
Direct methods
Direct slots
Slot: accessor
Initargs

:accessor

Readers

accessor (generic function)

Writers

(setf accessor) (generic function)

Slot: originals
Initform

(make-hash-table :test (quote eq))

Readers

originals (generic function)

Writers

(setf originals) (generic function)

Class: increase-accessor-tween ()

Combination of a constant-tween and an accessor-tween.

Creation: (increase accessor :by by :for for)

See CONSTANT-TWEEN
See ACCESSOR-TWEEN

Package

flare

Source

change.lisp (file)

Direct superclasses
Class: queue-iterator ()
Package

flare-queue

Source

queue.lisp (file)

Direct superclasses

iterator (class)

Direct methods
  • next (method)
  • current (method)
  • has-more (method)
  • tail (method)
  • tail (method)
Direct slots
Slot: tail
Initargs

:tail

Readers

tail (generic function)

Writers

(setf tail) (generic function)

Class: range-accessor-tween ()

Combination of a range-tween and an accessor-tween.

Creation: (set accessor :ease easing-func :from from :to to)

See RANGE-TWEEN
See ACCESSOR-TWEEN

Package

flare

Source

change.lisp (file)

Direct superclasses

Previous: , Up: Internal definitions   [Contents][Index]

5.2.6 Types

Type: interval-designator ()

An interval-designator can be either a real, T, or NIL.

Package

flare

Source

parser.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L  
Index Entry  Section

F
File, Lisp, flare.asd: The flare<dot>asd file
File, Lisp, flare/animation.lisp: The flare/animation<dot>lisp file
File, Lisp, flare/change.lisp: The flare/change<dot>lisp file
File, Lisp, flare/clock.lisp: The flare/clock<dot>lisp file
File, Lisp, flare/container.lisp: The flare/container<dot>lisp file
File, Lisp, flare/documentation.lisp: The flare/documentation<dot>lisp file
File, Lisp, flare/easings.lisp: The flare/easings<dot>lisp file
File, Lisp, flare/forms.lisp: The flare/forms<dot>lisp file
File, Lisp, flare/indexed-set.lisp: The flare/indexed-set<dot>lisp file
File, Lisp, flare/package.lisp: The flare/package<dot>lisp file
File, Lisp, flare/paintable.lisp: The flare/paintable<dot>lisp file
File, Lisp, flare/parser.lisp: The flare/parser<dot>lisp file
File, Lisp, flare/queue.lisp: The flare/queue<dot>lisp file
File, Lisp, flare/scene.lisp: The flare/scene<dot>lisp file
File, Lisp, flare/toolkit.lisp: The flare/toolkit<dot>lisp file
flare.asd: The flare<dot>asd file
flare/animation.lisp: The flare/animation<dot>lisp file
flare/change.lisp: The flare/change<dot>lisp file
flare/clock.lisp: The flare/clock<dot>lisp file
flare/container.lisp: The flare/container<dot>lisp file
flare/documentation.lisp: The flare/documentation<dot>lisp file
flare/easings.lisp: The flare/easings<dot>lisp file
flare/forms.lisp: The flare/forms<dot>lisp file
flare/indexed-set.lisp: The flare/indexed-set<dot>lisp file
flare/package.lisp: The flare/package<dot>lisp file
flare/paintable.lisp: The flare/paintable<dot>lisp file
flare/parser.lisp: The flare/parser<dot>lisp file
flare/queue.lisp: The flare/queue<dot>lisp file
flare/scene.lisp: The flare/scene<dot>lisp file
flare/toolkit.lisp: The flare/toolkit<dot>lisp file

L
Lisp File, flare.asd: The flare<dot>asd file
Lisp File, flare/animation.lisp: The flare/animation<dot>lisp file
Lisp File, flare/change.lisp: The flare/change<dot>lisp file
Lisp File, flare/clock.lisp: The flare/clock<dot>lisp file
Lisp File, flare/container.lisp: The flare/container<dot>lisp file
Lisp File, flare/documentation.lisp: The flare/documentation<dot>lisp file
Lisp File, flare/easings.lisp: The flare/easings<dot>lisp file
Lisp File, flare/forms.lisp: The flare/forms<dot>lisp file
Lisp File, flare/indexed-set.lisp: The flare/indexed-set<dot>lisp file
Lisp File, flare/package.lisp: The flare/package<dot>lisp file
Lisp File, flare/paintable.lisp: The flare/paintable<dot>lisp file
Lisp File, flare/parser.lisp: The flare/parser<dot>lisp file
Lisp File, flare/queue.lisp: The flare/queue<dot>lisp file
Lisp File, flare/scene.lisp: The flare/scene<dot>lisp file
Lisp File, flare/toolkit.lisp: The flare/toolkit<dot>lisp file

Jump to:   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   H   I   L   M   N   O   P   Q   R   S   T   U   V   W  
Index Entry  Section

(
(setf accessor): Internal generic functions
(setf accessor): Internal generic functions
(setf angle): Exported generic functions
(setf angle): Exported generic functions
(setf angle): Exported generic functions
(setf animatable): Exported generic functions
(setf animatable): Exported generic functions
(setf animations): Exported generic functions
(setf animations): Exported generic functions
(setf animations): Exported generic functions
(setf animations): Exported generic functions
(setf beginning): Exported generic functions
(setf beginning): Exported generic functions
(setf by): Internal generic functions
(setf by): Internal generic functions
(setf changes): Exported generic functions
(setf changes): Exported generic functions
(setf clock): Exported generic functions
(setf clock): Exported generic functions
(setf clock): Exported generic functions
(setf creator): Exported generic functions
(setf creator): Exported generic functions
(setf defindex): Internal generic functions
(setf defindex): Internal generic functions
(setf definition): Internal generic functions
(setf definition): Internal generic functions
(setf duration): Exported generic functions
(setf duration): Exported generic functions
(setf ease-func): Internal generic functions
(setf ease-func): Internal generic functions
(setf easing): Exported functions
(setf for): Internal generic functions
(setf for): Internal generic functions
(setf from): Internal generic functions
(setf from): Internal generic functions
(setf func): Internal generic functions
(setf func): Internal generic functions
(setf future-animations): Exported generic functions
(setf future-animations): Exported generic functions
(setf head): Internal generic functions
(setf head): Internal generic functions
(setf instances): Exported generic functions
(setf instances): Exported generic functions
(setf left): Exported functions
(setf location): Exported generic functions
(setf location): Exported generic functions
(setf location): Exported generic functions
(setf name-map): Exported generic functions
(setf name-map): Exported generic functions
(setf objects): Exported generic functions
(setf objects): Exported generic functions
(setf objects): Exported generic functions
(setf objects): Exported generic functions
(setf orientation): Exported generic functions
(setf orientation): Exported generic functions
(setf orientation): Exported generic functions
(setf originals): Exported generic functions
(setf originals): Exported generic functions
(setf originals): Exported generic functions
(setf past-animations): Exported generic functions
(setf past-animations): Exported generic functions
(setf present-animations): Exported generic functions
(setf present-animations): Exported generic functions
(setf previous-time): Internal generic functions
(setf previous-time): Internal generic functions
(setf progression-definition): Exported functions
(setf progressions): Exported generic functions
(setf progressions): Exported generic functions
(setf queue-value-at): Exported functions
(setf right): Exported functions
(setf running): Exported generic functions
(setf running): Exported generic functions
(setf scene-graph): Exported generic functions
(setf scene-graph): Exported generic functions
(setf scene-graph): Exported generic functions
(setf scene-graph): Exported generic functions
(setf selector): Exported generic functions
(setf selector): Exported generic functions
(setf set): Internal generic functions
(setf set): Internal generic functions
(setf set-value-at): Exported functions
(setf size): Exported generic functions
(setf size): Exported generic functions
(setf size): Exported generic functions
(setf slot): Exported generic functions
(setf slot): Exported generic functions
(setf spacing): Exported generic functions
(setf spacing): Exported generic functions
(setf spacing): Exported generic functions
(setf start): Exported generic functions
(setf start): Exported generic functions
(setf tail): Internal generic functions
(setf tail): Internal generic functions
(setf tail): Internal generic functions
(setf tangent): Internal generic functions
(setf tangent): Internal generic functions
(setf timescale): Exported generic functions
(setf timescale): Exported generic functions
(setf to): Internal generic functions
(setf to): Internal generic functions
(setf unit): Exported generic functions
(setf unit): Exported generic functions
(setf up): Exported generic functions
(setf up): Exported generic functions
(setf up): Exported generic functions
(setf value): Exported functions
(setf visibility): Exported generic functions
(setf visibility): Exported generic functions

A
accessor: Internal generic functions
accessor: Internal generic functions
add-progression: Exported generic functions
add-progression: Exported generic functions
add-progression: Exported generic functions
angle: Exported generic functions
angle: Exported generic functions
animatable: Exported generic functions
animatable: Exported generic functions
animation<: Internal functions
animation>: Internal functions
animations: Exported generic functions
animations: Exported generic functions

B
beginning: Exported generic functions
beginning: Exported generic functions
by: Internal generic functions
by: Internal generic functions

C
call-with-translation: Exported generic functions
cell-insert-before: Exported functions
cell-remove: Exported functions
changes: Exported generic functions
changes: Exported generic functions
clear: Exported generic functions
clear: Exported generic functions
clear-queue: Exported functions
clear-set: Exported functions
clock: Exported generic functions
clock: Exported generic functions
coerce-queue: Exported functions
coerce-set: Exported functions
compile-animations: Internal macros
compile-change: Internal macros
compile-constraint: Internal functions
compile-selector: Internal functions
copy: Internal generic functions
copy: Internal generic functions
copy: Internal generic functions
copy: Internal generic functions
copy: Internal generic functions
copy: Internal generic functions
copy: Internal generic functions
copy: Internal generic functions
copy: Internal generic functions
copy-animations: Internal functions
creator: Exported generic functions
creator: Exported generic functions

D
defindex: Internal generic functions
defindex: Internal generic functions
define-change-parser: Exported macros
define-easing: Exported macros
define-progression: Exported macros
define-self-returning-method: Internal macros
definition: Internal generic functions
definition: Internal generic functions
dequeue: Exported functions
deregister: Exported generic functions
deregister: Exported generic functions
deregister: Exported generic functions
deregister: Exported generic functions
designator-p: Internal functions
do-container-tree: Exported macros
do-queue: Exported macros
do-set: Exported macros
duration: Exported generic functions
duration: Exported generic functions

E
ease: Exported functions
ease-func: Internal generic functions
ease-func: Internal generic functions
ease-object: Exported generic functions
ease-object: Exported generic functions
ease-object: Exported generic functions
easing: Exported functions
enqueue: Exported functions
ensure-sorted: Internal functions
enter: Exported generic functions
enter: Exported generic functions
enter: Exported generic functions
enter: Exported generic functions
enter: Exported generic functions
enter: Exported generic functions
enter: Exported generic functions

F
for: Internal generic functions
for: Internal generic functions
format-progression: Internal functions
from: Internal generic functions
from: Internal generic functions
func: Internal generic functions
func: Internal generic functions
Function, (setf easing): Exported functions
Function, (setf left): Exported functions
Function, (setf progression-definition): Exported functions
Function, (setf queue-value-at): Exported functions
Function, (setf right): Exported functions
Function, (setf set-value-at): Exported functions
Function, (setf value): Exported functions
Function, animation<: Internal functions
Function, animation>: Internal functions
Function, cell-insert-before: Exported functions
Function, cell-remove: Exported functions
Function, clear-queue: Exported functions
Function, clear-set: Exported functions
Function, coerce-queue: Exported functions
Function, coerce-set: Exported functions
Function, compile-constraint: Internal functions
Function, compile-selector: Internal functions
Function, copy-animations: Internal functions
Function, dequeue: Exported functions
Function, designator-p: Internal functions
Function, ease: Exported functions
Function, easing: Exported functions
Function, enqueue: Exported functions
Function, ensure-sorted: Internal functions
Function, format-progression: Internal functions
Function, in-queue-p: Exported functions
Function, in-set-p: Exported functions
Function, left: Exported functions
Function, make-cell: Internal functions
Function, make-indexed-set: Exported functions
Function, make-queue: Exported functions
Function, map-container-tree: Exported functions
Function, map-queue: Exported functions
Function, map-set: Exported functions
Function, parse-animation: Internal functions
Function, parse-intervals: Internal functions
Function, print-container-tree: Exported functions
Function, progression-definition: Exported functions
Function, queue-first: Exported functions
Function, queue-index-of: Exported functions
Function, queue-last: Exported functions
Function, queue-remove: Exported functions
Function, queue-size: Exported functions
Function, queue-value-at: Exported functions
Function, remove-easing: Exported functions
Function, remove-progression-definition: Exported functions
Function, right: Exported functions
Function, set-add: Exported functions
Function, set-first: Exported functions
Function, set-index-of: Exported functions
Function, set-last: Exported functions
Function, set-remove: Exported functions
Function, set-size: Exported functions
Function, set-value-at: Exported functions
Function, shift-array-elements: Internal functions
Function, simulate-progression: Internal functions
Function, value: Exported functions
future-animations: Exported generic functions
future-animations: Exported generic functions

G
Generic Function, (setf accessor): Internal generic functions
Generic Function, (setf angle): Exported generic functions
Generic Function, (setf animatable): Exported generic functions
Generic Function, (setf animations): Exported generic functions
Generic Function, (setf beginning): Exported generic functions
Generic Function, (setf by): Internal generic functions
Generic Function, (setf changes): Exported generic functions
Generic Function, (setf clock): Exported generic functions
Generic Function, (setf creator): Exported generic functions
Generic Function, (setf defindex): Internal generic functions
Generic Function, (setf definition): Internal generic functions
Generic Function, (setf duration): Exported generic functions
Generic Function, (setf ease-func): Internal generic functions
Generic Function, (setf for): Internal generic functions
Generic Function, (setf from): Internal generic functions
Generic Function, (setf func): Internal generic functions
Generic Function, (setf future-animations): Exported generic functions
Generic Function, (setf head): Internal generic functions
Generic Function, (setf instances): Exported generic functions
Generic Function, (setf location): Exported generic functions
Generic Function, (setf name-map): Exported generic functions
Generic Function, (setf objects): Exported generic functions
Generic Function, (setf orientation): Exported generic functions
Generic Function, (setf originals): Exported generic functions
Generic Function, (setf past-animations): Exported generic functions
Generic Function, (setf present-animations): Exported generic functions
Generic Function, (setf previous-time): Internal generic functions
Generic Function, (setf progressions): Exported generic functions
Generic Function, (setf running): Exported generic functions
Generic Function, (setf scene-graph): Exported generic functions
Generic Function, (setf selector): Exported generic functions
Generic Function, (setf set): Internal generic functions
Generic Function, (setf size): Exported generic functions
Generic Function, (setf slot): Exported generic functions
Generic Function, (setf spacing): Exported generic functions
Generic Function, (setf start): Exported generic functions
Generic Function, (setf tail): Internal generic functions
Generic Function, (setf tangent): Internal generic functions
Generic Function, (setf timescale): Exported generic functions
Generic Function, (setf to): Internal generic functions
Generic Function, (setf unit): Exported generic functions
Generic Function, (setf up): Exported generic functions
Generic Function, (setf visibility): Exported generic functions
Generic Function, accessor: Internal generic functions
Generic Function, add-progression: Exported generic functions
Generic Function, angle: Exported generic functions
Generic Function, animatable: Exported generic functions
Generic Function, animations: Exported generic functions
Generic Function, beginning: Exported generic functions
Generic Function, by: Internal generic functions
Generic Function, call-with-translation: Exported generic functions
Generic Function, changes: Exported generic functions
Generic Function, clear: Exported generic functions
Generic Function, clock: Exported generic functions
Generic Function, copy: Internal generic functions
Generic Function, creator: Exported generic functions
Generic Function, defindex: Internal generic functions
Generic Function, definition: Internal generic functions
Generic Function, deregister: Exported generic functions
Generic Function, duration: Exported generic functions
Generic Function, ease-func: Internal generic functions
Generic Function, ease-object: Exported generic functions
Generic Function, enter: Exported generic functions
Generic Function, for: Internal generic functions
Generic Function, from: Internal generic functions
Generic Function, func: Internal generic functions
Generic Function, future-animations: Exported generic functions
Generic Function, head: Internal generic functions
Generic Function, insert: Internal generic functions
Generic Function, instances: Exported generic functions
Generic Function, leave: Exported generic functions
Generic Function, location: Exported generic functions
Generic Function, name: Exported generic functions
Generic Function, name-map: Exported generic functions
Generic Function, objects: Exported generic functions
Generic Function, orientation: Exported generic functions
Generic Function, original-value: Exported generic functions
Generic Function, originals: Exported generic functions
Generic Function, paint: Exported generic functions
Generic Function, parse-change: Internal generic functions
Generic Function, past-animations: Exported generic functions
Generic Function, present-animations: Exported generic functions
Generic Function, previous-time: Internal generic functions
Generic Function, progression: Exported generic functions
Generic Function, progression-instance: Exported generic functions
Generic Function, progressions: Exported generic functions
Generic Function, register: Exported generic functions
Generic Function, remove-progression: Exported generic functions
Generic Function, reposition: Internal generic functions
Generic Function, reset: Exported generic functions
Generic Function, running: Exported generic functions
Generic Function, scene-graph: Exported generic functions
Generic Function, selector: Exported generic functions
Generic Function, set: Internal generic functions
Generic Function, set-size: Internal generic functions
Generic Function, size: Exported generic functions
Generic Function, size: Internal generic functions
Generic Function, slot: Exported generic functions
Generic Function, spacing: Exported generic functions
Generic Function, start: Exported generic functions
Generic Function, stop: Exported generic functions
Generic Function, synchronize: Exported generic functions
Generic Function, tail: Internal generic functions
Generic Function, tangent: Internal generic functions
Generic Function, tick: Exported generic functions
Generic Function, timescale: Exported generic functions
Generic Function, to: Internal generic functions
Generic Function, tween-value: Internal generic functions
Generic Function, unit: Exported generic functions
Generic Function, units: Exported generic functions
Generic Function, up: Exported generic functions
Generic Function, update: Exported generic functions
Generic Function, visibility: Exported generic functions
Generic Function, withdraw: Internal generic functions

H
head: Internal generic functions
head: Internal generic functions

I
in-queue-p: Exported functions
in-set-p: Exported functions
insert: Internal generic functions
insert: Internal generic functions
instances: Exported generic functions
instances: Exported generic functions

L
leave: Exported generic functions
leave: Exported generic functions
leave: Exported generic functions
leave: Exported generic functions
leave: Exported generic functions
leave: Exported generic functions
left: Exported functions
location: Exported generic functions
location: Exported generic functions

M
Macro, compile-animations: Internal macros
Macro, compile-change: Internal macros
Macro, define-change-parser: Exported macros
Macro, define-easing: Exported macros
Macro, define-progression: Exported macros
Macro, define-self-returning-method: Internal macros
Macro, do-container-tree: Exported macros
Macro, do-queue: Exported macros
Macro, do-set: Exported macros
Macro, with-translation: Exported macros
make-cell: Internal functions
make-indexed-set: Exported functions
make-queue: Exported functions
map-container-tree: Exported functions
map-queue: Exported functions
map-set: Exported functions
Method, (setf accessor): Internal generic functions
Method, (setf angle): Exported generic functions
Method, (setf angle): Exported generic functions
Method, (setf animatable): Exported generic functions
Method, (setf animations): Exported generic functions
Method, (setf animations): Exported generic functions
Method, (setf animations): Exported generic functions
Method, (setf beginning): Exported generic functions
Method, (setf by): Internal generic functions
Method, (setf changes): Exported generic functions
Method, (setf clock): Exported generic functions
Method, (setf clock): Exported generic functions
Method, (setf creator): Exported generic functions
Method, (setf defindex): Internal generic functions
Method, (setf definition): Internal generic functions
Method, (setf duration): Exported generic functions
Method, (setf ease-func): Internal generic functions
Method, (setf for): Internal generic functions
Method, (setf from): Internal generic functions
Method, (setf func): Internal generic functions
Method, (setf future-animations): Exported generic functions
Method, (setf head): Internal generic functions
Method, (setf instances): Exported generic functions
Method, (setf location): Exported generic functions
Method, (setf location): Exported generic functions
Method, (setf name-map): Exported generic functions
Method, (setf objects): Exported generic functions
Method, (setf objects): Exported generic functions
Method, (setf objects): Exported generic functions
Method, (setf orientation): Exported generic functions
Method, (setf orientation): Exported generic functions
Method, (setf originals): Exported generic functions
Method, (setf originals): Exported generic functions
Method, (setf past-animations): Exported generic functions
Method, (setf present-animations): Exported generic functions
Method, (setf previous-time): Internal generic functions
Method, (setf progressions): Exported generic functions
Method, (setf running): Exported generic functions
Method, (setf scene-graph): Exported generic functions
Method, (setf scene-graph): Exported generic functions
Method, (setf scene-graph): Exported generic functions
Method, (setf selector): Exported generic functions
Method, (setf set): Internal generic functions
Method, (setf size): Exported generic functions
Method, (setf size): Exported generic functions
Method, (setf slot): Exported generic functions
Method, (setf spacing): Exported generic functions
Method, (setf spacing): Exported generic functions
Method, (setf start): Exported generic functions
Method, (setf tail): Internal generic functions
Method, (setf tail): Internal generic functions
Method, (setf tangent): Internal generic functions
Method, (setf timescale): Exported generic functions
Method, (setf to): Internal generic functions
Method, (setf unit): Exported generic functions
Method, (setf up): Exported generic functions
Method, (setf up): Exported generic functions
Method, (setf visibility): Exported generic functions
Method, accessor: Internal generic functions
Method, add-progression: Exported generic functions
Method, add-progression: Exported generic functions
Method, angle: Exported generic functions
Method, animatable: Exported generic functions
Method, animations: Exported generic functions
Method, beginning: Exported generic functions
Method, by: Internal generic functions
Method, changes: Exported generic functions
Method, clear: Exported generic functions
Method, clock: Exported generic functions
Method, copy: Internal generic functions
Method, copy: Internal generic functions
Method, copy: Internal generic functions
Method, copy: Internal generic functions
Method, copy: Internal generic functions
Method, copy: Internal generic functions
Method, copy: Internal generic functions
Method, copy: Internal generic functions
Method, creator: Exported generic functions
Method, defindex: Internal generic functions
Method, definition: Internal generic functions
Method, deregister: Exported generic functions
Method, deregister: Exported generic functions
Method, deregister: Exported generic functions
Method, duration: Exported generic functions
Method, ease-func: Internal generic functions
Method, ease-object: Exported generic functions
Method, ease-object: Exported generic functions
Method, enter: Exported generic functions
Method, enter: Exported generic functions
Method, enter: Exported generic functions
Method, enter: Exported generic functions
Method, enter: Exported generic functions
Method, enter: Exported generic functions
Method, for: Internal generic functions
Method, from: Internal generic functions
Method, func: Internal generic functions
Method, future-animations: Exported generic functions
Method, head: Internal generic functions
Method, insert: Internal generic functions
Method, instances: Exported generic functions
Method, leave: Exported generic functions
Method, leave: Exported generic functions
Method, leave: Exported generic functions
Method, leave: Exported generic functions
Method, leave: Exported generic functions
Method, location: Exported generic functions
Method, name: Exported generic functions
Method, name-map: Exported generic functions
Method, objects: Exported generic functions
Method, objects: Exported generic functions
Method, objects: Exported generic functions
Method, orientation: Exported generic functions
Method, original-value: Exported generic functions
Method, original-value: Exported generic functions
Method, originals: Exported generic functions
Method, originals: Exported generic functions
Method, paint: Exported generic functions
Method, paint: Exported generic functions
Method, parse-change: Internal generic functions
Method, parse-change: Internal generic functions
Method, parse-change: Internal generic functions
Method, parse-change: Internal generic functions
Method, parse-change: Internal generic functions
Method, parse-change: Internal generic functions
Method, parse-change: Internal generic functions
Method, parse-change: Internal generic functions
Method, past-animations: Exported generic functions
Method, present-animations: Exported generic functions
Method, previous-time: Internal generic functions
Method, progression: Exported generic functions
Method, progression-instance: Exported generic functions
Method, progression-instance: Exported generic functions
Method, progressions: Exported generic functions
Method, register: Exported generic functions
Method, register: Exported generic functions
Method, register: Exported generic functions
Method, remove-progression: Exported generic functions
Method, reposition: Internal generic functions
Method, reposition: Internal generic functions
Method, reset: Exported generic functions
Method, reset: Exported generic functions
Method, reset: Exported generic functions
Method, reset: Exported generic functions
Method, reset: Exported generic functions
Method, reset: Exported generic functions
Method, reset: Exported generic functions
Method, reset: Exported generic functions
Method, reset: Exported generic functions
Method, reset: Exported generic functions
Method, reset: Exported generic functions
Method, running: Exported generic functions
Method, scene-graph: Exported generic functions
Method, selector: Exported generic functions
Method, set: Internal generic functions
Method, set-size: Internal generic functions
Method, size: Exported generic functions
Method, size: Internal generic functions
Method, slot: Exported generic functions
Method, spacing: Exported generic functions
Method, start: Exported generic functions
Method, start: Exported generic functions
Method, start: Exported generic functions
Method, start: Exported generic functions
Method, stop: Exported generic functions
Method, stop: Exported generic functions
Method, synchronize: Exported generic functions
Method, synchronize: Exported generic functions
Method, synchronize: Exported generic functions
Method, tail: Internal generic functions
Method, tail: Internal generic functions
Method, tangent: Internal generic functions
Method, tick: Exported generic functions
Method, tick: Exported generic functions
Method, tick: Exported generic functions
Method, tick: Exported generic functions
Method, tick: Exported generic functions
Method, tick: Exported generic functions
Method, tick: Exported generic functions
Method, timescale: Exported generic functions
Method, to: Internal generic functions
Method, tween-value: Internal generic functions
Method, tween-value: Internal generic functions
Method, tween-value: Internal generic functions
Method, tween-value: Internal generic functions
Method, unit: Exported generic functions
Method, unit: Exported generic functions
Method, units: Exported generic functions
Method, up: Exported generic functions
Method, update: Exported generic functions
Method, update: Exported generic functions
Method, update: Exported generic functions
Method, update: Exported generic functions
Method, update: Exported generic functions
Method, update: Exported generic functions
Method, update: Exported generic functions
Method, visibility: Exported generic functions
Method, withdraw: Internal generic functions

N
name: Exported generic functions
name: Exported generic functions
name-map: Exported generic functions
name-map: Exported generic functions

O
objects: Exported generic functions
objects: Exported generic functions
objects: Exported generic functions
objects: Exported generic functions
orientation: Exported generic functions
orientation: Exported generic functions
original-value: Exported generic functions
original-value: Exported generic functions
original-value: Exported generic functions
originals: Exported generic functions
originals: Exported generic functions
originals: Exported generic functions

P
paint: Exported generic functions
paint: Exported generic functions
paint: Exported generic functions
parse-animation: Internal functions
parse-change: Internal generic functions
parse-change: Internal generic functions
parse-change: Internal generic functions
parse-change: Internal generic functions
parse-change: Internal generic functions
parse-change: Internal generic functions
parse-change: Internal generic functions
parse-change: Internal generic functions
parse-change: Internal generic functions
parse-intervals: Internal functions
past-animations: Exported generic functions
past-animations: Exported generic functions
present-animations: Exported generic functions
present-animations: Exported generic functions
previous-time: Internal generic functions
previous-time: Internal generic functions
print-container-tree: Exported functions
progression: Exported generic functions
progression: Exported generic functions
progression-definition: Exported functions
progression-instance: Exported generic functions
progression-instance: Exported generic functions
progression-instance: Exported generic functions
progressions: Exported generic functions
progressions: Exported generic functions

Q
queue-first: Exported functions
queue-index-of: Exported functions
queue-last: Exported functions
queue-remove: Exported functions
queue-size: Exported functions
queue-value-at: Exported functions

R
register: Exported generic functions
register: Exported generic functions
register: Exported generic functions
register: Exported generic functions
remove-easing: Exported functions
remove-progression: Exported generic functions
remove-progression: Exported generic functions
remove-progression-definition: Exported functions
reposition: Internal generic functions
reposition: Internal generic functions
reposition: Internal generic functions
reset: Exported generic functions
reset: Exported generic functions
reset: Exported generic functions
reset: Exported generic functions
reset: Exported generic functions
reset: Exported generic functions
reset: Exported generic functions
reset: Exported generic functions
reset: Exported generic functions
reset: Exported generic functions
reset: Exported generic functions
reset: Exported generic functions
right: Exported functions
running: Exported generic functions
running: Exported generic functions

S
scene-graph: Exported generic functions
scene-graph: Exported generic functions
selector: Exported generic functions
selector: Exported generic functions
set: Internal generic functions
set: Internal generic functions
set-add: Exported functions
set-first: Exported functions
set-index-of: Exported functions
set-last: Exported functions
set-remove: Exported functions
set-size: Exported functions
set-size: Internal generic functions
set-size: Internal generic functions
set-value-at: Exported functions
shift-array-elements: Internal functions
simulate-progression: Internal functions
size: Exported generic functions
size: Exported generic functions
size: Internal generic functions
size: Internal generic functions
slot: Exported generic functions
slot: Exported generic functions
spacing: Exported generic functions
spacing: Exported generic functions
start: Exported generic functions
start: Exported generic functions
start: Exported generic functions
start: Exported generic functions
start: Exported generic functions
stop: Exported generic functions
stop: Exported generic functions
stop: Exported generic functions
synchronize: Exported generic functions
synchronize: Exported generic functions
synchronize: Exported generic functions
synchronize: Exported generic functions

T
tail: Internal generic functions
tail: Internal generic functions
tail: Internal generic functions
tangent: Internal generic functions
tangent: Internal generic functions
tick: Exported generic functions
tick: Exported generic functions
tick: Exported generic functions
tick: Exported generic functions
tick: Exported generic functions
tick: Exported generic functions
tick: Exported generic functions
tick: Exported generic functions
timescale: Exported generic functions
timescale: Exported generic functions
to: Internal generic functions
to: Internal generic functions
tween-value: Internal generic functions
tween-value: Internal generic functions
tween-value: Internal generic functions
tween-value: Internal generic functions
tween-value: Internal generic functions

U
unit: Exported generic functions
unit: Exported generic functions
unit: Exported generic functions
units: Exported generic functions
units: Exported generic functions
up: Exported generic functions
up: Exported generic functions
update: Exported generic functions
update: Exported generic functions
update: Exported generic functions
update: Exported generic functions
update: Exported generic functions
update: Exported generic functions
update: Exported generic functions
update: Exported generic functions

V
value: Exported functions
visibility: Exported generic functions
visibility: Exported generic functions

W
with-translation: Exported macros
withdraw: Internal generic functions
withdraw: Internal generic functions

Jump to:   (  
A   B   C   D   E   F   G   H   I   L   M   N   O   P   Q   R   S   T   U   V   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
A   B   C   D   E   F   H   I   L   N   O   P   R   S   T   U   V  
Index Entry  Section

*
*animation-defindex*: Internal special variables
*ease-docs*: Internal special variables
*easings*: Internal special variables
*i*: Internal special variables
*mapper*: Internal special variables
*progressions*: Internal special variables
*resetting*: Internal special variables

A
accessor: Internal classes
active: Exported classes
angle: Exported classes
animatable: Exported classes
animations: Exported classes

B
beginning: Exported classes
by: Exported classes

C
changes: Exported classes
clock: Exported classes
creator: Exported classes

D
defindex: Exported classes
definition: Exported classes
duration: Exported classes

E
ease-func: Exported classes
ended: Exported classes

F
for: Exported classes
from: Exported classes
func: Exported classes
future: Exported classes

H
head: Exported classes

I
instances: Exported classes

L
left: Exported structures
location: Exported classes

N
name: Exported classes
name-map: Exported classes

O
objects: Exported classes
objects: Exported classes
objects: Exported classes
orientation: Exported classes
originals: Exported classes
originals: Internal classes

P
previous-time: Exported classes
progressions: Exported classes

R
right: Exported structures
running: Exported classes

S
scene-graph: Exported classes
selector: Exported classes
set: Exported classes
size: Exported classes
size: Exported classes
slot: Exported classes
Slot, accessor: Internal classes
Slot, active: Exported classes
Slot, angle: Exported classes
Slot, animatable: Exported classes
Slot, animations: Exported classes
Slot, beginning: Exported classes
Slot, by: Exported classes
Slot, changes: Exported classes
Slot, clock: Exported classes
Slot, creator: Exported classes
Slot, defindex: Exported classes
Slot, definition: Exported classes
Slot, duration: Exported classes
Slot, ease-func: Exported classes
Slot, ended: Exported classes
Slot, for: Exported classes
Slot, from: Exported classes
Slot, func: Exported classes
Slot, future: Exported classes
Slot, head: Exported classes
Slot, instances: Exported classes
Slot, left: Exported structures
Slot, location: Exported classes
Slot, name: Exported classes
Slot, name-map: Exported classes
Slot, objects: Exported classes
Slot, objects: Exported classes
Slot, objects: Exported classes
Slot, orientation: Exported classes
Slot, originals: Exported classes
Slot, originals: Internal classes
Slot, previous-time: Exported classes
Slot, progressions: Exported classes
Slot, right: Exported structures
Slot, running: Exported classes
Slot, scene-graph: Exported classes
Slot, selector: Exported classes
Slot, set: Exported classes
Slot, size: Exported classes
Slot, size: Exported classes
Slot, slot: Exported classes
Slot, spacing: Exported classes
Slot, start: Exported classes
Slot, tail: Exported classes
Slot, tail: Internal classes
Slot, tangent: Exported classes
Slot, timescale: Exported classes
Slot, to: Exported classes
Slot, up: Exported classes
Slot, value: Exported structures
Slot, visibility: Exported classes
spacing: Exported classes
Special Variable, *animation-defindex*: Internal special variables
Special Variable, *ease-docs*: Internal special variables
Special Variable, *easings*: Internal special variables
Special Variable, *i*: Internal special variables
Special Variable, *mapper*: Internal special variables
Special Variable, *progressions*: Internal special variables
Special Variable, *resetting*: Internal special variables
start: Exported classes

T
tail: Exported classes
tail: Internal classes
tangent: Exported classes
timescale: Exported classes
to: Exported classes

U
up: Exported classes

V
value: Exported structures
visibility: Exported classes

Jump to:   *  
A   B   C   D   E   F   H   I   L   N   O   P   R   S   T   U   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   A   C   E   F   I   L   O   P   Q   R   S   T   U  
Index Entry  Section

A
accessor-tween: Internal classes
animatable: Exported classes
animation: Exported classes
arc: Exported classes

C
call-accessor-tween: Exported classes
call-change: Exported classes
call-slot-tween: Exported classes
cell: Exported structures
change: Exported classes
Class, accessor-tween: Internal classes
Class, animatable: Exported classes
Class, animation: Exported classes
Class, arc: Exported classes
Class, call-accessor-tween: Exported classes
Class, call-change: Exported classes
Class, call-slot-tween: Exported classes
Class, change: Exported classes
Class, clock: Exported classes
Class, constant-tween: Exported classes
Class, container: Exported classes
Class, container-unit: Exported classes
Class, enter-operation: Exported classes
Class, entity: Exported classes
Class, formation: Exported classes
Class, increase-accessor-tween: Internal classes
Class, increase-slot-tween: Exported classes
Class, indexed-set: Exported classes
Class, leave-operation: Exported classes
Class, operation: Exported classes
Class, oriented-entity: Exported classes
Class, paintable: Exported classes
Class, particle: Exported classes
Class, print-change: Exported classes
Class, progression: Exported classes
Class, progression-definition: Exported classes
Class, queue: Exported classes
Class, queue-iterator: Internal classes
Class, range-accessor-tween: Internal classes
Class, range-slot-tween: Exported classes
Class, range-tween: Exported classes
Class, ring: Exported classes
Class, scene: Exported classes
Class, scene-graph: Exported classes
Class, sized-entity: Exported classes
Class, slot-tween: Exported classes
Class, target: Exported classes
Class, tween: Exported classes
Class, unit: Exported classes
clock: Exported classes
constant-tween: Exported classes
container: Exported classes
container-unit: Exported classes

E
enter-operation: Exported classes
entity: Exported classes

F
flare: The flare system
flare: The flare package
flare-indexed-set: The flare-indexed-set package
flare-queue: The flare-queue package
formation: Exported classes

I
increase-accessor-tween: Internal classes
increase-slot-tween: Exported classes
indexed-set: Exported classes
interval-designator: Internal types

L
leave-operation: Exported classes

O
operation: Exported classes
oriented-entity: Exported classes

P
Package, flare: The flare package
Package, flare-indexed-set: The flare-indexed-set package
Package, flare-queue: The flare-queue package
paintable: Exported classes
particle: Exported classes
print-change: Exported classes
progression: Exported classes
progression-definition: Exported classes

Q
queue: Exported classes
queue-iterator: Internal classes

R
range-accessor-tween: Internal classes
range-slot-tween: Exported classes
range-tween: Exported classes
ring: Exported classes

S
scene: Exported classes
scene-graph: Exported classes
sized-entity: Exported classes
slot-tween: Exported classes
Structure, cell: Exported structures
System, flare: The flare system

T
target: Exported classes
tween: Exported classes
Type, interval-designator: Internal types

U
unit: Exported classes

Jump to:   A   C   E   F   I   L   O   P   Q   R   S   T   U