[This is preliminary documentation and is subject to change.]
The Inspector type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Inspector |
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 |
Dispose of the PM form, if still open
(Overrides SceneObject..::.FinaliseSimulation()()().) |
| 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
(Inherited from IcarusApplication.) |
| gettitle | (Overrides IcarusApplication..::.gettitle()()().) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitApplication |
This routine is not called as the Inspector is not
added into the normal Applications library
(Overrides IcarusApplication..::.InitApplication(Project).) |
| 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 | (Overrides IcarusApplication..::.InitThreadSafe()()().) |
| MemberwiseClone | Overloaded. |
| OnHideApplication | (Overrides IcarusApplication..::.OnHideApplication()()().) |
| OnMouseClick |
On Mouse Click event
(Inherited from IcarusApplication.) |
| OnMouseDown |
On Mouse Down event
(Inherited from IcarusApplication.) |
| OnMouseMove |
On Mouse Move event
(Inherited from IcarusApplication.) |
| OnMouseUp |
On Mouse Up event
(Inherited from IcarusApplication.) |
| OnShowApplication | (Overrides IcarusApplication..::.OnShowApplication()()().) |
| 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
(Inherited from IcarusApplication.) |
| pmform |
The WinForm that represents the visual element
|
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.) |
| Focused |
Determines whether the form currently has focus or not
|
| 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.) |
See Also
