|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--yaarq.sys.yrqEngine
This class is the main class of the Yaarq engine. It provides support for instantiating and accessing all subclasses, for intialisation of the Java3D environment and the scene graph, and it allows applications to interact with it through a number of callback functions.
The engine class is self-contained, to use it applications just have to declare a new instance of it passing themselves as the parenting instance. All other operations will be done by the engine via the callback functions defined in the yrqApplication interface.
TODO: Nothing
| Constructor Summary | |
yrqEngine(yrqApplication a_application)
Creates an instance of the engine. |
|
| Method Summary | |
void |
addFrame(java.lang.String a_name,
yrqFrame a_frame)
This function adds a new root frame to the engines map of frames. |
void |
clearFrames()
This method clears all frames from the frame hierarchy, detaching them in the process. |
yrqApplication |
getApplication()
This function retrieves the yrqApplication instance encapsuling the engine for purpose of callback issuing by subordinate classes. |
yrqCanvas |
getCanvas()
This function returns the canvas instance used by the engine |
java.awt.Component |
getComponent()
Returns the component the engine is attached to. |
yrqEnviron |
getEnviron()
This function retrieves the environ subclass instance used by the engine to manage environmental effects. |
yrqFrame |
getFrame(java.lang.String a_name)
This function retrieves one of the frames stored in the engines internal frame map by its name. |
long |
getFrameCount()
This function retrieves the current absolute number of frames which have elapsed since starting the engine. |
long |
getFrameRate()
This function retrieves the current fps rate which is measured in the internal frame-based update loop of the yrqEngine instance. |
yrqRepository |
getRepository()
This function retrieves the repository subclass instance used by the engine to keep low-level objects like textures and sounds. |
javax.media.j3d.BranchGroup |
getRoot()
This function retrieves the root branch group of the engine, to which all other sub-instance branch groups are childed |
yrqViewport |
getViewport()
This function returns the viewport instance used by the engine |
void |
removeFrame(java.lang.String a_name)
This function removes a frame from the engines internal map of root frames by name. |
void |
removeFrame(yrqFrame a_frame)
This function removes a frame from the engines internal map of root frames by reference. |
void |
update()
This method is an implementation of the yrqUpdatable interface. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public yrqEngine(yrqApplication a_application)
a_application - The application which wishes to instantiate the class| Method Detail |
public void addFrame(java.lang.String a_name,
yrqFrame a_frame)
a_name - The name under which to add the framea_frame - The frame instance to add.public void clearFrames()
public yrqApplication getApplication()
public yrqCanvas getCanvas()
public java.awt.Component getComponent()
public yrqEnviron getEnviron()
yrqEnvironpublic yrqFrame getFrame(java.lang.String a_name)
a_name - The name of the frame
public long getFrameCount()
public long getFrameRate()
public yrqRepository getRepository()
yrqRepositorypublic javax.media.j3d.BranchGroup getRoot()
public yrqViewport getViewport()
public void removeFrame(java.lang.String a_name)
a_name - the name of the frame to be removed.public void removeFrame(yrqFrame a_frame)
a_frame - the frame to be removed.public void update()
yrqUpdatable,
yrqApplication
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||