CloudMax: CloudMax moved page Z64anim to App:Z64anim: Moved to proper namespace

2014-07-07T09:20:00Z

CloudMax moved page Z64anim to App:Z64anim: Moved to proper namespace

Mzxrules: 1 revision

2014-06-08T23:22:09Z

1 revision

Spinout at 07:53, 27 September 2011

2011-09-27T07:53:38Z

New page

{{lowercase title}}
{{ infobox software
| name = z64anim
| screenshot = [[Image:z64anim-stalfos.png|320px]]
| caption = ''z64anim console and viewing window''
| author = spinout
| operating system = Cross platform
| language = English
| programming language = C
| genre = CLI tool
| license = Open Source
| website = [https://bitbucket.org/ottehr/z64anim/ z64anim] on bitbucket.
| game = all (works with [[Animation Format|objects]])
}}
'''z64anim''' is a tool in development by [[User:spinout|spinout]] with the purpose of viewing and modifying an [[Animation_Format|animated object]]'s animation and skeleton. It uses SDL, GL, threads, [[libobj]], [[User:xdaniel|xdaniel]]'s [[OZMAV|libbadRDP]] and the required dependencies for these libraries - libpng and lz. In its current state, it has two windows: a viewing window, and a command-line console window. The console has many commands which control viewing and editing of animations. The window is used for display list, translation and rotation axis selection and manipulation on a more graphical level.<br>
On August 19, 2011, spinout put z64anim on bitbucket<sup>[https://bitbucket.org/ottehr/z64anim/changeset/b9ede3d78b7f]</sup>, and there has been some development going on as of mid September 2011. All future binary and sources can be found [https://bitbucket.org/ottehr/z64anim/downloads here].
==Usage==
Before using:
*Be at least somewhat familiar with [[Animation Format|skeletons and animations]] - an understanding of the binary structure is not critical but an understanding of rotations used in animations and translation of children/next limbs is reccomended
*Make sure you have the latest version of z64anim
*Make sure you have your object ready to use. You could do some trickery with the -o and -s CMD arguments (see below) to load an object directly from ROM, but I do not recommend doing so and I am not completely sure if the saving routine will work as expected.
===Invoking z64anim===
z64anim can, optionally, be passed command line arguments. The last argument is to be an object containing [[Animation Format|Animations]]. The arguments before that can be:
;-G:Enable OpenGL ARB extensions in badrdp
;-o OFF:Read data from the input file starting at offset OFF (Default: 0)
;-s SIZ:Read SIZ bytes of data. (Default: OFF -> end)
;-b BASE:Set base address of data to BASE (Default: 0x06000000)
Example:<br>
z64anim.exe object_sk2.zobj
Due to the fact that z64anim expects the last argument to be the object file itself, an object file can be dragged and dropped onto the application.
===Window controls===
'''Keyboard controls'''
<table border=1>
<tr><td>Key(s)</td><td>Action</td></tr>
<tr><td>w,s,a,d</td><td>Move camera</td></tr>
<tr><td>q,e</td><td>Change camera speed</td></tr>
<tr><td>r</td><td>Reset camera</td></tr>
<tr><td>u,j</td><td>Increase/decrease animation playback speed</td></tr>
<tr><td>h,k</td><td>Change to next/previous animation</td></tr>
<tr><td>(space)</td><td>Pause/play animation</td></tr>
<tr><td>y,i</td><td>Increase/decrease current animation/translation value</td></tr>
<tr><td>o,l</td><td>Increase/decrease current animation index</td></tr>
<tr><td>(up arrow)</td><td>Select previous limb</td></tr>
<tr><td>(down arrow)</td><td>Select next limb</td></tr>
<tr><td>(right arrow)</td><td>Select parent limb</td></tr>
<tr><td>(left arrow)</td><td>Select child limb</td></tr>
<tr><td>x</td><td>Toggle x/y/z axis</td></tr>
<tr><td>v</td><td>Toggle drawing of rotation guides</td></tr>
<tr><td>m</td><td>Switch edit mode (display list/translation/rotation)</td></tr>
</table>
'''Mouse Controls'''<br>
The mouse is used for camera rotation when the left mouse button is held and dragged, and display lists/editing axis (when visible) can be selected with a right click.

===Console Commands===
====Basics====
These commands are always available, even when an object isn't loaded.
;help:Print all controls for console and viewing window.
;quit:Exit z64anim
;load F B A S:Load S bytes from file F at offset A as address B. If B, A, and S are ommited, it is assumed to load the entire file from base address 0x06000000 - which is what most objects use.
====Viewer Control====
These commands control the rendering animation in the rendering window.
;pause:Pause playing the current animation. Rendering window equivalent (toggle): (space)
;play:Resume playing the current animation. Rendering window equivalent (toggle): (space)

;step:Step the current animation by one frame. Rendering window equivalent: 'n'
;hideaxis:Hide editor axis of each joint. Rendering window equivalent (toggle): 'v'
;showaxis:Show editor axis of each joint. Rendering window equivalent (toggle): 'v'
;select-disable:Disable selection of displaylists or editor axis
;select-enable:Enable selection of displaylists or editor axis
;scale V:Set the scale of the editor axis

====Animation====
;anim-info:List information on the current animation
;anim-list:List all known animations
;anim-switch N:Switch the current animation to animation N.
;anim-next:Switch to the next animation. Rendering window equivalent: 'k' ('h' for previous in rendering window)
;anim-rotations:List all valid rotation indicies

====Skeleton====
;skel-info:Display skeleton information
;skel-reset:Reset the entire skeleton to the state it was at when last opened or saved

====Display Lists====
;dl-list:List all known display lists
;dl-switch N:Change current limb's display list to display list N
;dl-curr:Print current display list
;dl-export OBJ:Export the current DL as wavefront .obj
;dl-import OBJ SIZ:Import the wavefront .obj file in FILE at size SCALE. Todo: Allow user to specify what display list # or a new index.

====Values====
;val-info:Print information on currently selected value
;val-set V:Set the current value (rotation, translation and display list #s)
;val-index I:Set the current rotation index (rotations only)
;val-series S I:Set the series of animated rotation values starting at S degrees increasing by I degrees each frame
;val-seriesr S I:Set the series of animated rotation values starting at S degrees increasing by I degrees for each frame for the first half of the frames, then decreasing by I back to S

====Selection====
;axis A:Switch to axis A (either `x', `y' or `z'). Rendering window equivalent (toggle): 'x'
;rot:Switch to editing rotation. Rendering window equivalent (toggle): 'm'
;trans:Switch to editing translation. Rendering window equivalent (toggle): 'm'
;dlist:Switch to editing display list. Rendering window equivalent (toggle): 'm'
;child:Select the current limb's child, if possible. Rendering window equivalent: (right)
;parent:Select the current limb's parent, if possible. Rendering window equivalent: (left)
;next:Select the next limb, if possible. Rendering window equivalent: (up)
;previous:Select the previous limb, if possible. Rendering window equivalent: (down)

====Miscellaneous====
;save:Apply all changes made
;adopt N:Set the current limb's child to limb N

====Planned====
I'm probably going to have to write a library which stores and describes binary data with local pointers to implement all of these commands.
;dl-export-all DIR:Export all DLs as wavefront .obj
;dl-scale S:Scale the current display list to scale S
;val-reset:Reset the current value
;add-dlist OFFSET: Add the display list at OFFSET to the list of known display lists
;anim-new: Create and select a new one-frame animation with no animated values.
;anim-setframes N:Make the animation an N framed animation (adding & removing frames as needed)
;anim-addtrack:Add a new animated list of values
;anim-rmtrack:Remove an animated list of values
;anim-addstill:Add a new still value
;anim-rmstill:Remove a still value
;skel-new:create a new skeleton with one limb
;addchild:Add a child limb
;rmchild:Remove the child limb and it's children/siblings (assuming they are not used elsewhere)
;popchild:Set the child limb to the child limb's sibling limb, destroy original child limb and it's children which are not used elsewhere.
;addnext:Add a next limb
;rmnext:Remove the next limb and it's children (assuming they are not used elsewhere)
All of these functions which modify how many members are in a hierarchy/skeleton must also fix animations.

[[Category: Software]]

← Older revision	Revision as of 09:20, 7 July 2014
(No difference)

← Older revision	Revision as of 23:22, 8 June 2014
(No difference)

App:Z64anim - Revision history

CloudMax: CloudMax moved page Z64anim to App:Z64anim: Moved to proper namespace

Mzxrules: 1 revision

Spinout at 07:53, 27 September 2011