Visual3D Game EngineAPI Documentation for XNA, C#, VB, and .NET
Assembly: Visual3D (in Visual3D.dll) Version: 1.0.0.0 (1.0.0.0)
Core interface for Visual3D Activities, which breath life into your Visual3D scenes and worlds.
Namespace: Visual3DAssembly: Visual3D (in Visual3D.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
| C# | Visual Basic |
public interface IActivity : IActivated, IDisposable, IHasNameID, INamed, IOwned, IInitialized
Public Interface IActivity _ Inherits IActivated, IDisposable, IHasNameID, INamed, _ IOwned, IInitialized
Members
| All Members | Properties | Methods | Events |
| Member | Description | |
|---|---|---|
| Activate()()()() | Activates this component. (Inherited from IActivated.) | |
| Activate(IComponentOwner) | Called to activate (i.e. "Start") the Activity. For components, this is called when they become 'Active' in the scene. | |
| Activated | Event fires when the when the Activity becomes Activated. | |
| ActivationFrameNumber | ||
| ActiveChildIndex | Event fires when SpeedScalar is Changed. | |
| Deactivate()()()() | Deactivates this component. (Inherited from IActivated.) | |
| Deactivated | Event fires when the final execution of the activity completes, right after it becomes Deactivated. | |
| HasOwner<(Of <<'(TOwner>)>>)(IOwned) | (Inherited from EntityExtensions.) | |
| HasOwner<(Of <<'(TOwner>)>>)(IOwned, TOwner%) | (Inherited from EntityExtensions.) | |
| HasOwner<(Of <<'(TOwner>)>>)(IOwned, TOwner%, Boolean) | (Inherited from EntityExtensions.) | |
| Initialize()()()() | Calls logic to initialize this object instance. Upon success, IsInitialized must then become 'true'. (Inherited from IInitialized.) | |
| Initialize(IComponentOwner) | Called when Activity is first attached to an Owner, or upon completion of instantiation with Owner already set. | |
| IsActive | Indicates if component is currently Active or not. Note that setting this to 'true' or 'false' must implicitly call
the appropriate method, Activate()()()() or Deactivate()()()(). (Inherited from IActivated.) | |
| IsInitialized | Indicates if this object instance has been Initialized yet (by calling Initialize()()()()). (Inherited from IInitialized.) | |
| Name | (Inherited from INamed.) | |
| NameID | (Inherited from IHasNameID.) | |
| Owner | (Inherited from IOwned.) | |
| Reset()()()() | Called from 'Activate()' method, or can be called manually. Should initialize custom state of the Activity.
Note, that if the Activity is currently executing, this should have no effect upon the current Activity state. | |
| SetActivationFrameNumber(Int32) |