[This is preliminary documentation and is subject to change.]
The Project type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | Project |
Create the project, adding in a default set of objects to make up a simple scene
|
Methods
| Name | Description | |
|---|---|---|
| Applications | |
| 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 |
An overridable function to get the name of the Object, useful
for fixed objects, or providing read-only references, etc..
(Inherited from SceneObject.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| 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.) |
| MemberwiseClone | Overloaded. |
| Render | |
| RenderDesign |
This is the HIGH LEVEL project render solution, which sets up the viewports and renders the application
(Overrides SceneObject..::.RenderDesign(RenderStruct).) |
| RenderNormal |
This is the HIGH LEVEL project render solution, which sets up the viewports and renders the application
(Overrides SceneObject..::.RenderNormal(RenderStruct).) |
| 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.) |
| CurrentApplication | |
| DefaultCam | |
| DefaultCollider | |
| DefaultViewport | |
| filename | |
 | isLocked | (Inherited from SceneObject.) |
| lx | |
| ly | |
| lz | |
| mouse | |
| mouseX | |
| mouseY |
Properties
| Name | Description | |
|---|---|---|
 | ActiveGeoms | |
| Assets | |
| 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.) |
| Filename | |
| FPS | |
| FPSframes | |
| FPSmaximum | |
| FPSseconds | |
| Locked |
Locked represents a Designer feature only. It is used to determine whether the object can currently be selected
(Inherited from SceneObject.) |
| Mouse3D | |
| MouseX | |
| MouseY | |
| Name |
The Name of the object, used by the Designer. Calls getname() to get the current name
(Inherited from SceneObject.) |
| State |
See Also
