The flare Reference Manual

Table of Contents

The flare Reference Manual

This is the flare Reference Manual, version 1.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 13:29:29 2020 GMT+0.

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

• The first animation takes place from the 0th second to the 0th second, so it will only ever happen exactly once. It applies to the scene object itself and causes only a single change. This change enters a ring of size 100 with a single sphere child of size 10 into the scene.
• The second animation takes place from the 0th second to infinity, so it'll go on as long as we keep the scene running. It applies to the children of the scene object (in this case the ring) and has a single change that will increase the angle by 360 every second.

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.

2 Systems

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

2.1 flare

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://Shinmera.github.io/flare/

Source Control

(:git "https://github.com/shinmera/flare.git")

Bug Tracker

https://github.com/Shinmera/flare/issues

License

zlib

Description

Easy particle systems with fine grained control.

Version

1.1.0

Dependencies

• lambda-fiddle
• array-utils
• trivial-garbage
• 3d-vectors
• documentation-utils
• for

Source

flare.asd (file)

Components

• package.lisp (file)
• toolkit.lisp (file)
• queue.lisp (file)
• indexed-set.lisp (file)
• easings.lisp (file)
• clock.lisp (file)
• container.lisp (file)
• paintable.lisp (file)
• animation.lisp (file)
• change.lisp (file)
• parser.lisp (file)
• scene.lisp (file)
• forms.lisp (file)
• documentation.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 flare.asd

Location

flare.asd

Systems

flare (system)

3.1.2 flare/package.lisp

Parent

flare (system)

Location

package.lisp

Packages

• flare-queue
• flare-indexed-set
• flare

3.1.3 flare/toolkit.lisp

Dependency

package.lisp (file)

Parent

flare (system)

Location

toolkit.lisp

Internal Definitions

• define-self-returning-method (macro)
• ensure-sorted (function)

3.1.4 flare/queue.lisp

Dependency

toolkit.lisp (file)

Parent

flare (system)

Location

queue.lisp

Exported Definitions

• cell (structure)
• cell-insert-after (function)
• cell-insert-before (function)
• cell-remove (function)
• cell-tie (function)
• clear-queue (function)
• clear-set (function)
• coerce-queue (function)
• dequeue (function)
• do-queue (macro)
• do-set (macro)
• enqueue (function)
• in-queue-p (function)
• left (function)
• (setf left) (function)
• make-cell (function)
• make-queue (function)
• map-queue (function)
• map-set (function)
• queue (class)
• queue-first (function)
• queue-index-of (function)
• queue-last (function)
• queue-remove (function)
• queue-size (function)
• queue-value-at (function)
• (setf queue-value-at) (function)
• remove-cells (function)
• right (function)
• (setf right) (function)
• set-first (function)
• set-index-of (function)
• set-last (function)
• set-size (function)
• set-value-at (function)
• (setf set-value-at) (function)
• value (function)
• (setf value) (function)

Internal Definitions

• head (method)
• (setf head) (method)
• queue-iterator (class)
• set-size (method)
• size (method)
• tail (method)
• (setf tail) (method)
• tail (method)
• (setf tail) (method)

3.1.5 flare/indexed-set.lisp

Dependency

queue.lisp (file)

Parent

flare (system)

Location

indexed-set.lisp

Exported Definitions

• coerce-set (function)
• in-set-p (function)
• indexed-set (class)
• make-indexed-set (function)
• set-add (function)
• set-add-after (function)
• set-add-before (function)
• set-remove (function)

Internal Definitions

• set (method)
• (setf set) (method)

3.1.6 flare/easings.lisp

Dependency

indexed-set.lisp (file)

Parent

flare (system)

Location

easings.lisp

Exported Definitions

• define-easing (macro)
• ease (compiler macro)
• ease (function)
• ease-object (generic function)
• ease-object (method)
• ease-object (method)
• ease-object (method)
• ease-object (method)
• easing (function)
• (setf easing) (function)
• remove-easing (function)

Internal Definitions

• *ease-docs* (special variable)
• *easings* (special variable)

3.1.7 flare/clock.lisp

Dependency

easings.lisp (file)

Parent

flare (system)

Location

clock.lisp

Exported Definitions

• clock (generic function)
• clock (method)
• (setf clock) (method)
• clock (class)
• reset (generic function)
• reset (method)
• reset (method)
• running (generic function)
• running (method)
• (setf running) (method)
• start (generic function)
• start (method)
• start (method)
• stop (generic function)
• stop (method)
• stop (method)
• synchronize (generic function)
• synchronize (method)
• synchronize (method)
• synchronize (method)
• timescale (generic function)
• timescale (method)
• (setf timescale) (method)
• update (generic function)
• update (method)
• update (method)
• update (method)
• update (method)

Internal Definitions

• previous-time (method)
• (setf previous-time) (method)

3.1.8 flare/container.lisp

Dependency

clock.lisp (file)

Parent

flare (system)

Location

container.lisp

Exported Definitions

• clear (generic function)
• clear (method)
• container (class)
• container-unit (class)
• deregister (generic function)
• deregister (method)
• deregister (method)
• do-container-tree (macro)
• enter (generic function)
• enter (method)
• enter (method)
• enter (method)
• enter (method)
• leave (generic function)
• leave (method)
• leave (method)
• leave (method)
• leave (method)
• map-container-tree (function)
• name (generic function)
• name (method)
• name-map (generic function)
• name-map (method)
• (setf name-map) (method)
• objects (generic function)
• objects (method)
• (setf objects) (method)
• paint (method)
• print-container-tree (function)
• register (generic function)
• register (method)
• register (method)
• register (method)
• scene-graph (generic function)
• scene-graph (method)
• (setf scene-graph) (method)
• (setf scene-graph) (method)
• (setf scene-graph) (method)
• scene-graph (class)
• unit (generic function)
• unit (method)
• unit (method)
• (setf unit) (method)
• unit (class)
• units (generic function)
• units (method)
• update (method)

3.1.9 flare/paintable.lisp

Dependency

container.lisp (file)

Parent

flare (system)

Location

paintable.lisp

Exported Definitions

• call-with-translation (generic function)
• paint (generic function)
• paint (method)
• paintable (class)
• target (class)
• visibility (generic function)
• visibility (method)
• (setf visibility) (method)
• with-translation (macro)

3.1.10 flare/animation.lisp

Dependency

paintable.lisp (file)

Parent

flare (system)

Location

animation.lisp

Exported Definitions

• add-progression (generic function)
• add-progression (method)
• add-progression (method)
• animatable (method)
• (setf animatable) (method)
• animatable (class)
• animation (class)
• animations (generic function)
• animations (method)
• (setf animations) (method)
• (setf animations) (method)
• (setf animations) (method)
• beginning (generic function)
• beginning (method)
• (setf beginning) (method)
• changes (generic function)
• changes (method)
• (setf changes) (method)
• (setf clock) (method)
• duration (generic function)
• duration (method)
• (setf duration) (method)
• enter (method)
• enter (method)
• future-animations (generic function)
• future-animations (method)
• (setf future-animations) (method)
• instances (generic function)
• instances (method)
• (setf instances) (method)
• leave (method)
• past-animations (generic function)
• past-animations (method)
• (setf past-animations) (method)
• present-animations (generic function)
• present-animations (method)
• (setf present-animations) (method)
• progression (generic function)
• progression (method)
• progression (method)
• progression (class)
• progression-definition (class)
• progression-instance (generic function)
• progression-instance (method)
• progressions (generic function)
• progressions (method)
• (setf progressions) (method)
• remove-progression (generic function)
• remove-progression (method)
• reset (method)
• reset (method)
• reset (method)
• selector (generic function)
• selector (method)
• (setf selector) (method)
• tick (generic function)
• tick (method)
• update (method)
• update (method)

Internal Definitions

• *resetting* (special variable)
• animation< (function)
• animation> (function)
• copy (generic function)
• copy (method)
• copy-animations (function)
• defindex (method)
• (setf defindex) (method)
• definition (method)
• (setf definition) (method)
• format-progression (function)
• shift-array-elements (function)
• simulate-progression (function)

3.1.11 flare/change.lisp

Dependency

animation.lisp (file)

Parent

flare (system)

Location

change.lisp

Exported Definitions

• call-accessor-tween (class)
• call-change (class)
• call-slot-tween (class)
• change (class)
• constant-tween (class)
• creator (method)
• (setf creator) (method)
• define-change-parser (macro)
• enter-operation (class)
• increase-slot-tween (class)
• leave-operation (class)
• objects (method)
• objects (method)
• (setf objects) (method)
• (setf objects) (method)
• operation (class)
• original-value (generic function)
• original-value (method)
• original-value (method)
• originals (method)
• (setf originals) (method)
• originals (method)
• (setf originals) (method)
• print-change (class)
• range-slot-tween (class)
• range-tween (class)
• reset (method)
• reset (method)
• reset (method)
• reset (method)
• reset (method)
• reset (method)
• slot (method)
• (setf slot) (method)
• slot-tween (class)
• start (method)
• (setf start) (method)
• tick (method)
• tick (method)
• tick (method)
• tick (method)
• tick (method)
• tick (method)
• tween (class)

Internal Definitions

• accessor (method)
• (setf accessor) (method)
• accessor-tween (class)
• by (method)
• (setf by) (method)
• copy (method)
• copy (method)
• copy (method)
• copy (method)
• copy (method)
• copy (method)
• copy (method)
• ease-func (method)
• (setf ease-func) (method)
• for (method)
• (setf for) (method)
• from (method)
• (setf from) (method)
• func (method)
• (setf func) (method)
• increase-accessor-tween (class)
• parse-change (generic function)
• parse-change (method)
• parse-change (method)
• parse-change (method)
• parse-change (method)
• parse-change (method)
• parse-change (method)
• parse-change (method)
• parse-change (method)
• range-accessor-tween (class)
• to (method)
• (setf to) (method)
• tween-value (generic function)
• tween-value (method)
• tween-value (method)
• tween-value (method)
• tween-value (method)

3.1.12 flare/parser.lisp

Dependency

change.lisp (file)

Parent

flare (system)

Location

parser.lisp

Exported Definitions

• define-progression (macro)
• progression-definition (function)
• (setf progression-definition) (function)
• progression-instance (method)
• remove-progression-definition (function)

Internal Definitions

• *animation-defindex* (special variable)
• *i* (special variable)
• *mapper* (special variable)
• *progressions* (special variable)
• compile-animations (macro)
• compile-change (macro)
• compile-constraint (function)
• compile-selector (function)
• designator-p (function)
• interval-designator (type)
• parse-animation (function)
• parse-intervals (function)

3.1.13 flare/scene.lisp

Dependency

parser.lisp (file)

Parent

flare (system)

Location

scene.lisp

Exported Definitions

• entity (class)
• location (generic function)
• location (method)
• (setf location) (method)
• scene (class)
• start (method)

3.1.14 flare/forms.lisp

Dependency

scene.lisp (file)

Parent

flare (system)

Location

forms.lisp

Exported Definitions

• angle (generic function)
• angle (method)
• (setf angle) (method)
• (setf angle) (method)
• arc (class)
• formation (class)
• (setf location) (method)
• orientation (generic function)
• orientation (method)
• (setf orientation) (method)
• (setf orientation) (method)
• oriented-entity (class)
• particle (class)
• ring (class)
• size (generic function)
• size (method)
• (setf size) (method)
• (setf size) (method)
• sized-entity (class)
• spacing (generic function)
• spacing (method)
• (setf spacing) (method)
• (setf spacing) (method)
• up (generic function)
• up (method)
• (setf up) (method)
• (setf up) (method)

Internal Definitions

• insert (method)
• reposition (generic function)
• reposition (method)
• reposition (method)
• tangent (method)
• (setf tangent) (method)
• withdraw (method)

3.1.15 flare/documentation.lisp

Dependency

forms.lisp (file)

Parent

flare (system)

Location

documentation.lisp

4 Packages

Packages are listed by definition order.

4.1 flare-queue

Source

package.lisp (file)

Nickname

org.shirakumo.flare.queue

Use List

• for
• common-lisp

Used By List

• flare
• flare-indexed-set

Exported Definitions

• cell (structure)
• cell-insert-after (function)
• cell-insert-before (function)
• cell-remove (function)
• cell-tie (function)
• clear-queue (function)
• coerce-queue (function)
• dequeue (function)
• do-queue (macro)
• enqueue (function)
• in-queue-p (function)
• left (function)
• (setf left) (function)
• make-cell (function)
• make-queue (function)
• map-queue (function)
• queue (class)
• queue-first (function)
• queue-index-of (function)
• queue-last (function)
• queue-remove (function)
• queue-size (function)
• queue-value-at (function)
• (setf queue-value-at) (function)
• remove-cells (function)
• right (function)
• (setf right) (function)
• value (function)
• (setf value) (function)

Internal Definitions

• head (generic function)
• head (method)
• (setf head) (method)
• (setf head) (generic function)
• queue-iterator (class)
• set-size (generic function)
• set-size (method)
• size (generic function)
• size (method)
• tail (generic function)
• tail (method)
• (setf tail) (method)
• tail (method)
• (setf tail) (method)
• (setf tail) (generic function)

4.2 flare-indexed-set

Source

package.lisp (file)

Nickname

org.shirakumo.flare.indexed-set

Use List

• flare-queue
• common-lisp

Used By List

flare

Exported Definitions

• clear-set (function)
• coerce-set (function)
• do-set (macro)
• in-set-p (function)
• indexed-set (class)
• make-indexed-set (function)
• map-set (function)
• set-add (function)
• set-add-after (function)
• set-add-before (function)
• set-first (function)
• set-index-of (function)
• set-last (function)
• set-remove (function)
• set-size (function)
• set-value-at (function)
• (setf set-value-at) (function)

Internal Definitions

• set (generic function)
• set (method)
• (setf set) (method)
• (setf set) (generic function)

4.3 flare

Source

package.lisp (file)

Nickname

org.shirakumo.flare

Use List

• flare-indexed-set
• flare-queue
• 3d-vectors
• common-lisp

Exported Definitions

• add-progression (generic function)
• add-progression (method)
• add-progression (method)
• angle (generic function)
• angle (method)
• (setf angle) (generic function)
• (setf angle) (method)
• (setf angle) (method)
• animatable (generic function)
• animatable (method)
• (setf animatable) (method)
• (setf animatable) (generic function)
• animatable (class)
• animation (class)
• animations (generic function)
• animations (method)
• (setf animations) (generic function)
• (setf animations) (method)
• (setf animations) (method)
• (setf animations) (method)
• arc (class)
• beginning (generic function)
• beginning (method)
• (setf beginning) (generic function)
• (setf beginning) (method)
• call-accessor-tween (class)
• call-change (class)
• call-slot-tween (class)
• call-with-translation (generic function)
• change (class)
• changes (generic function)
• changes (method)
• (setf changes) (generic function)
• (setf changes) (method)
• clear (generic function)
• clear (method)
• clock (generic function)
• clock (method)
• (setf clock) (generic function)
• (setf clock) (method)
• (setf clock) (method)
• clock (class)
• constant-tween (class)
• container (class)
• container-unit (class)
• creator (generic function)
• creator (method)
• (setf creator) (method)
• (setf creator) (generic function)
• define-change-parser (macro)
• define-easing (macro)
• define-progression (macro)
• deregister (generic function)
• deregister (method)
• deregister (method)
• do-container-tree (macro)
• duration (generic function)
• duration (method)
• (setf duration) (generic function)
• (setf duration) (method)
• ease (compiler macro)
• ease (function)
• ease-object (generic function)
• ease-object (method)
• ease-object (method)
• ease-object (method)
• ease-object (method)
• easing (function)
• (setf easing) (function)
• enter (generic function)
• enter (method)
• enter (method)
• enter (method)
• enter (method)
• enter (method)
• enter (method)
• enter-operation (class)
• entity (class)
• formation (class)
• future-animations (generic function)
• future-animations (method)
• (setf future-animations) (generic function)
• (setf future-animations) (method)
• increase-slot-tween (class)
• instances (generic function)
• instances (method)
• (setf instances) (generic function)
• (setf instances) (method)
• leave (generic function)
• leave (method)
• leave (method)
• leave (method)
• leave (method)
• leave (method)
• leave-operation (class)
• location (generic function)
• location (method)
• (setf location) (generic function)
• (setf location) (method)
• (setf location) (method)
• map-container-tree (function)
• name (generic function)
• name (method)
• name-map (generic function)
• name-map (method)
• (setf name-map) (generic function)
• (setf name-map) (method)
• objects (generic function)
• objects (method)
• objects (method)
• objects (method)
• (setf objects) (generic function)
• (setf objects) (method)
• (setf objects) (method)
• (setf objects) (method)
• operation (class)
• orientation (generic function)
• orientation (method)
• (setf orientation) (generic function)
• (setf orientation) (method)
• (setf orientation) (method)
• oriented-entity (class)
• original-value (generic function)
• original-value (method)
• original-value (method)
• originals (generic function)
• originals (method)
• (setf originals) (method)
• originals (method)
• (setf originals) (method)
• (setf originals) (generic function)
• paint (generic function)
• paint (method)
• paint (method)
• paintable (class)
• particle (class)
• past-animations (generic function)
• past-animations (method)
• (setf past-animations) (generic function)
• (setf past-animations) (method)
• present-animations (generic function)
• present-animations (method)
• (setf present-animations) (generic function)
• (setf present-animations) (method)
• print-change (class)
• print-container-tree (function)
• progression (generic function)
• progression (method)
• progression (method)
• progression (class)
• progression-definition (function)
• (setf progression-definition) (function)
• progression-definition (class)
• progression-instance (generic function)
• progression-instance (method)
• progression-instance (method)
• progressions (generic function)
• progressions (method)
• (setf progressions) (generic function)
• (setf progressions) (method)
• range-slot-tween (class)
• range-tween (class)
• register (generic function)
• register (method)
• register (method)
• register (method)
• remove-easing (function)
• remove-progression (generic function)
• remove-progression (method)
• remove-progression-definition (function)
• reset (generic function)
• reset (method)
• reset (method)
• reset (method)
• reset (method)
• reset (method)
• reset (method)
• reset (method)
• reset (method)
• reset (method)
• reset (method)
• reset (method)
• ring (class)
• running (generic function)
• running (method)
• (setf running) (generic function)
• (setf running) (method)
• scene (class)
• scene-graph (generic function)
• scene-graph (method)
• (setf scene-graph) (generic function)
• (setf scene-graph) (method)
• (setf scene-graph) (method)
• (setf scene-graph) (method)
• scene-graph (class)
• selector (generic function)
• selector (method)
• (setf selector) (generic function)
• (setf selector) (method)
• size (generic function)
• size (method)
• (setf size) (generic function)
• (setf size) (method)
• (setf size) (method)
• sized-entity (class)
• slot (generic function)
• slot (method)
• (setf slot) (method)
• (setf slot) (generic function)
• slot-tween (class)
• spacing (generic function)
• spacing (method)
• (setf spacing) (generic function)
• (setf spacing) (method)
• (setf spacing) (method)
• start (generic function)
• start (method)
• start (method)
• start (method)
• start (method)
• (setf start) (generic function)
• (setf start) (method)
• stop (generic function)
• stop (method)
• stop (method)
• synchronize (generic function)
• synchronize (method)
• synchronize (method)
• synchronize (method)
• target (class)
• tick (generic function)
• tick (method)
• tick (method)
• tick (method)
• tick (method)
• tick (method)
• tick (method)
• tick (method)
• timescale (generic function)
• timescale (method)
• (setf timescale) (generic function)
• (setf timescale) (method)
• tween (class)
• unit (generic function)
• unit (method)
• unit (method)
• (setf unit) (generic function)
• (setf unit) (method)
• unit (class)
• units (generic function)
• units (method)
• up (generic function)
• up (method)
• (setf up) (generic function)
• (setf up) (method)
• (setf up) (method)
• update (generic function)
• update (method)
• update (method)
• update (method)
• update (method)
• update (method)
• update (method)
• update (method)
• visibility (generic function)
• visibility (method)
• (setf visibility) (generic function)
• (setf visibility) (method)
• with-translation (macro)

Internal Definitions

• *animation-defindex* (special variable)
• *ease-docs* (special variable)
• *easings* (special variable)
• *i* (special variable)
• *mapper* (special variable)
• *progressions* (special variable)
• *resetting* (special variable)
• accessor (generic function)
• accessor (method)
• (setf accessor) (method)
• (setf accessor) (generic function)
• accessor-tween (class)
• animation< (function)
• animation> (function)
• by (generic function)
• by (method)
• (setf by) (method)
• (setf by) (generic function)
• compile-animations (macro)
• compile-change (macro)
• compile-constraint (function)
• compile-selector (function)
• copy (generic function)
• copy (method)
• copy (method)
• copy (method)
• copy (method)
• copy (method)
• copy (method)
• copy (method)
• copy (method)
• copy-animations (function)
• defindex (generic function)
• defindex (method)
• (setf defindex) (method)
• (setf defindex) (generic function)
• define-self-returning-method (macro)
• definition (generic function)
• definition (method)
• (setf definition) (method)
• (setf definition) (generic function)
• designator-p (function)
• ease-func (generic function)
• ease-func (method)
• (setf ease-func) (method)
• (setf ease-func) (generic function)
• ensure-sorted (function)
• for (generic function)
• for (method)
• (setf for) (method)
• (setf for) (generic function)
• format-progression (function)
• from (generic function)
• from (method)
• (setf from) (method)
• (setf from) (generic function)
• func (generic function)
• func (method)
• (setf func) (method)
• (setf func) (generic function)
• increase-accessor-tween (class)
• insert (generic function)
• insert (method)
• interval-designator (type)
• parse-animation (function)
• parse-change (generic function)
• parse-change (method)
• parse-change (method)
• parse-change (method)
• parse-change (method)
• parse-change (method)
• parse-change (method)
• parse-change (method)
• parse-change (method)
• parse-intervals (function)
• previous-time (generic function)
• previous-time (method)
• (setf previous-time) (method)
• (setf previous-time) (generic function)
• range-accessor-tween (class)
• reposition (generic function)
• reposition (method)
• reposition (method)
• shift-array-elements (function)
• simulate-progression (function)
• tangent (generic function)
• tangent (method)
• (setf tangent) (method)
• (setf tangent) (generic function)
• to (generic function)
• to (method)
• (setf to) (method)
• (setf to) (generic function)
• tween-value (generic function)
• tween-value (method)
• tween-value (method)
• tween-value (method)
• tween-value (method)
• withdraw (generic function)
• withdraw (method)

5 Definitions

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

5.1 Exported definitions

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 — A real (in seconds) that represents the starting time of the animations
end — A leal (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)

5.1.2 Compiler macros

Compiler Macro: ease X BY &optional FROM TO

Package

flare

Source

easings.lisp (file)

5.1.3 Functions

Function: cell-insert-after CELL NEIGHBOR

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

See CELL

Package

flare-queue

Source

queue.lisp (file)

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: cell-tie LEFT RIGHT

Tie the two cells together so that they become adjacent.

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-cell VALUE LEFT RIGHT

Constructs a new queue cell.

See CELL

Package

flare-queue

Source

queue.lisp (file)

Function: make-indexed-set ()

Creates a new indexed set.

See INDEXED-SET

Package

flare-indexed-set

Source

indexed-set.lisp (file)

Function: make-queue &rest ITEMS

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-cells LEFT RIGHT

Removes all cells between and including the given left and right cells.

Note that the consequences are undefined if the given left cell is actually to the right of the right cell, or if they are from different queues entirely.

See CELL

Package

flare-queue

Source

queue.lisp (file)

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-add-after BEFORE VALUE SET

Package

flare-indexed-set

Source

indexed-set.lisp (file)

Function: set-add-before AFTER VALUE 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)

5.1.4 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)

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 vec4) (TO vec4) X BY

Method: ease-object (FROM vec3) (TO vec3) X BY

Method: ease-object (FROM vec2) (TO vec2) 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.

The name may be NIL.

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

Return the first progression instance that matches the denominator within the container.

Package

flare

Source

animation.lisp (file)

Methods

Method: progression (DEFINITION symbol) ANIMATABLE

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