Aztec Script Reference

Scene Global Object

Summary

The global object "Scene" provides access to the objects within the current Aztec scene, as well as a reflection of the MScene API.

Methods

       The table below summarizes all currently implemented methods
       of the global object "Scene".
MethodDescription
createObject(objType)Create an object of type given by the string "objType".  Choices include: mesh, light, ...
createSceneObject()Create a generic object - typically used as a parent container.
createMesh()Create a mesh object with no vertices or triangles.
createLight()Create a new light object.
deleteObject(obj)Delete the object given by "obj".  Obj may be either a scene object of type AztecObject, or a string that holds the name of an Aztec object.
clearScene()Remove all objects from the scene.
getSelectedObjectList()Return an array containing references to all objects.
redraw()Force a redraw of the scene
selectNone()Deselect all objects in the scene
selectObject(obj)Add the object "obj" to the list of of selected objects.  Obj may be either an AztecObject, or a string that holds the name of an Aztec object.
getNumSelectedObjects()Return the number of currently selected objects.
getSelectionCenter()Return the location of the center of the list of all selected objects.  The type of the returned object is AztecVector3.
anythingSelected()Boolean that is true if there are any selected objects.
setTime(t)Set the current animation time.  The value of t is given in ticks.
setStartTime(t)Set the starting time of the animation in ticks.
getStartTime()Get the current start time of the animation in ticks.
getEndTime()Get the current end time of the animation in ticks.
setEndTime(t)Set the end time of the animation in ticks.
setTimeRange(t0, t1)Set the start and end time of the animation in ticks.
getFramesPerSecond()Get the number of frames per second used to generate the animation.
setFramesPerSecond(fps)Set the number of frames per second used to generate the animation.
tickToFrame(t)Convert a tick value to the frame it lies within.
frameToTick(t)Get the tick corresponding to the beginning of a specific frame.
tickToSeconds(t)Convert from ticks to seconds.
secondsToTick(t)Convert from seconds to ticks.

Properties

       The table below summarizes the properties of the global object "Scene".
PropertyDescription
ObjectNameAny object created in Aztec will appear as a property of the global object "Scene".

See Also

Groups [ Global Object ]
Documents [ LXR ID Search ]

This page was generated by APIDOC