[This is preliminary documentation and is subject to change.]
The IcarusApplication type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| IcarusApplication |
Methods
| Name | Description | |
|---|---|---|
| ChildEnumerator |
An enumerator to pass through all the child objects (not recursively)
for a specific type
(Inherited from SceneObject.) | |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) | |
| DisableObject |
Used by external API sets, like Physics, to Disable the object in the simulation
(Inherited from SceneObject.) | |
| EnableObject |
Used by external API sets, like Physics, to Enable the object in the simulation
(Inherited from SceneObject.) | |
| Equals | (Inherited from Object.) | |
| FinaliseSimulation |
Finalise (cleanup) the object at the end of Simulation
(Inherited from SceneObject.) | |
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
| GetHashCode | Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) | |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) | |
| getname |
Application title is assumed to be read-only, not much of a need to change it
during runtime
(Overrides SceneObject..::.getname()()().) | |
| gettitle |
Private method for returning the name.
| |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| InitApplication |
This procedure is called during the Initialisation thread, and as such
all calls must be thread-safe. No Open GL or WinForms calls are allowed here
| |
| InitialiseSimulation |
Initialise the object at the start of Simulation. This hierarchially calls all InitialiseSimulations in all children
Note that if the object is Disabled at the time of main simulation start,
then InitialiseSimulation is NOT called. It is up to the developer to
determine if a live call is needed should Enabled be set to True later.
(Inherited from SceneObject.) | |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) | |
| InitThreadSafe |
This procedure is called after the initialisation thread has executed
in a thread-safe environment
to allow custom controls to be added and to complete thread-unsafe calls
| |
| MemberwiseClone | Overloaded. | |
| OnHideApplication |
OnHideApplication is called to remove any external visual elements from the desktop
| |
| OnMouseClick |
On Mouse Click event
| |
| OnMouseDown |
On Mouse Down event
| |
| OnMouseMove |
On Mouse Move event
| |
| OnMouseUp |
On Mouse Up event
| |
| OnShowApplication |
This procedure is called to show any GUI controls in relation to the application
called from the main application thread
| |
| RenderDesign |
Render the object as a design element. This is intended to be overriden by descendents.
Once overridden, it can also be called to recursively render all Child objects.
In general, for rendering, do not wrap a push/pop matrix around this function, keep the matrices
clean and the behaviour consistent.
(Inherited from SceneObject.) | |
| RenderNormal |
Render the object normally. This is intended to be overriden by descendents.
Once overridden, it can also be called to recursively render all Child objects.
In general, for rendering, do not wrap a push/pop matrix around this function, keep the matrices
clean and the behaviour consistent.
(Inherited from SceneObject.) | |
| StepSimulation |
Advance the simulation by the specified timestep
(Inherited from SceneObject.) | |
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
| Children |
List of all the child objects underneath this object
(Inherited from SceneObject.) | |
| isLocked | (Inherited from SceneObject.) | |
| PATH |
Relative path to the application folder (includes last path separator)
This string is pre-computed by Icarus prior to calling InitApplication
|
Properties
| Name | Description | |
|---|---|---|
| Enabled |
If Enabled, the Object will participate in the Scene and Render accordingly.
Also, if Enabled, all child objects will subsequently Step the Simulation and Render accordingly.
(Inherited from SceneObject.) | |
| Locked |
Locked represents a Designer feature only. It is used to determine whether the object can currently be selected
(Inherited from SceneObject.) | |
| Name |
The Name of the object, used by the Designer. Calls getname() to get the current name
(Inherited from SceneObject.) |