Visual3D Game EngineAPI Documentation for XNA, C#, VB, and .NET
Updated Activity updates an IUpdated Object.

Namespace: Visual3D.Activities
Assembly: Visual3D (in Visual3D.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

      
 C#  Visual Basic 
[SerializableAttribute]
public class ObjectUpdater : Activity, 
	IUpdatedActivity, IActivity, IActivated, IDisposable, IHasNameID, 
	INamed, IOwned, IInitialized
<SerializableAttribute> _
Public Class ObjectUpdater _
	Inherits Activity _
	Implements IUpdatedActivity, IActivity, IActivated, IDisposable,  _
	IHasNameID, INamed, IOwned, IInitialized

Members

               
 All Members  Constructors   Properties   Methods   Events  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
ObjectUpdater()()()()
Initializes a new instance of the ObjectUpdater class
ObjectUpdater(String, SchedulerId, IUpdated)
Constructor - for Activity with InfiniteLoop.
Activate()()()()
Starts the Activity.
(Inherited from Activity.)
Activate(IComponentOwner)
Sets activity Owner and then Activates this activity.
(Inherited from Activity.)
Activated
Event fires when the when the Activity becomes Activated.
(Inherited from Activity.)
ActivationFrameNumber
Scheduler's Logical Frame when this Activity is to become Activated (or next time it will be updated, if IUpdatedActivity).
(Inherited from Activity.)
ActivityParent (Inherited from Activity.)
AssetID (Inherited from Registered.)
AssetInfo (Inherited from Registered.)
AssetOwner
Gets or sets the owner to which this asset belongs and is a member of.
(Inherited from Asset.)
AttachedToOwner(IComponentOwner) (Inherited from EntityComponent.)
BaseAsset (Inherited from Registered.)
Clone()()()()
Creates a clone of this Activity, but does NOT initialize it.
(Inherited from Activity.)
Clone(IComponentOwner)
Creates a clone of this Activity with optional arguments and assigns to specified Parent.
(Inherited from Activity.)
ComponentOwner
Owner of this component (contained in it's ".Components" container).
(Inherited from EntityComponent.)
Components
Components that are attached to this Entity.
(Inherited from ComponentBase.)
ComponentsForGlobalSceneFolders (Inherited from ComponentBase.)
Context
Defines the Owner of this component as well as the role (i.e. 'slot') that this component fulfills.
(Inherited from ComponentBase.)
CreateIdentity()()()() (Inherited from Registered.)
CreateIdentityList()()()() (Inherited from Registered.)
CreateInstance(Boolean)
Creates an instance or non-inheriting duplicate of this asset.
(Inherited from Asset.)
CreateService<(Of <<'(TService>)>>)()()()() (Inherited from ComponentBase.)
Deactivate()()()()
Deactivates (i.e. "Stops") this activity.
(Inherited from Activity.)
Deactivated
Event fires when the final execution of the activity completes, right after it becomes Deactivated.
(Inherited from Activity.)
DetachedFromOwner(IComponentOwner) (Inherited from EntityComponent.)
Dispose()()()() (Inherited from ComponentBase.)
Disposed (Inherited from ComponentBase.)
Equals(Object) (Overrides Object..::..Equals(Object).)
ExecutionCount
Number of executions that have occurred since this Activity was last Activated. When it reaches 'NumberOfExecutions', the Activity will then be 'Finished'.
(Inherited from Activity.)
ExecutionsRemaining
Number of Executions remaining before the Activity becomes 'Finished'.
(Inherited from Activity.)
GetHashCode()()()() (Overrides Object..::..GetHashCode()()()().)
GetService<(Of <<'(TService>)>>)()()()() (Inherited from ComponentBase.)
GetService<(Of <<'(TService>)>>)(TService%) (Inherited from ComponentBase.)
Handle (Inherited from Registered.)
HasComponents (Inherited from ComponentBase.)
HasHandle (Inherited from Registered.)
HasName (Inherited from EntityComponent.)
HasOwner<(Of <<'(TOwner>)>>)(IOwned) (Inherited from EntityExtensions.)
HasOwner<(Of <<'(TOwner>)>>)(IOwned, TOwner%) (Inherited from EntityExtensions.)
HasOwner<(Of <<'(TOwner>)>>)(IOwned, TOwner%, Boolean) (Inherited from EntityExtensions.)
HasPrototype
Gets if a prototype has been specified to inherit instance data from.
(Inherited from Asset.)
HasScope (Inherited from Registered.)
HasUniqueName
Gets if a UniqueName is specified to identify this asset with respect to its owner's other members.
(Inherited from Registered.)
ID (Inherited from Registered.)
IDChanged (Inherited from Registered.)
Initialize()()()()
Initializes the asset so that it might be prepared for use. By default, PrepareForUse() is called from this method as well.
(Inherited from Asset.)
Initialize(IComponentOwner)
Should only be called for Prototypes -- which will add this component to the list of prototype children that belong to this prototype parent.
(Inherited from Activity.)
IsActive
Indicates if the Activity is currently Activated (i.e. running).
(Inherited from Activity.)
IsActiveOrWaitingToActivate (Inherited from Activity.)
IsDeserialized
Indicates if Instance was created by Deserialization.
(Inherited from ComponentBase.)
IsDisposed
Indicates if resource has been disposed.
(Inherited from Asset.)
IsDisposing
Indicates if resource is in process of Disposing but not fully disposed.
(Inherited from Asset.)
IsEquivalent(Object)
Defaults to checking "Equals()" (often this mean "same instance"). Override to set less stringent Equivalence checking.
(Inherited from Activity.)
IsInitialized
Gets if this entity is currently in an initialized (and non-disposed) state.
(Inherited from Asset.)
IsLoopingForever
Indicates if this activity will continue execution indefinitely (i.e. "loop forever").
(Inherited from Activity.)
IsPrototype (Inherited from Asset.)
IsReadyForUse
Gets/sets if asset is ready to be used. Can be set to 'true' in class constructor in order to skip Preparation logic.
(Inherited from Asset.)
IsSaved
Indicates if the component is to be Saved when the owning context is saved (e.g. for components in your scene, this controls whether or not they are saved to the scene file when the scene is saved). Typically objects are 'Saved', unless they are transient to be programmatically created each time.
(Inherited from ComponentBase.)
IsSavedOnCreatingInstance (Inherited from Asset.)
IsWaitingToActivate (Inherited from Activity.)
Name (Inherited from EntityComponent.)
NameID (Inherited from EntityComponent.)
NextUpdateFrameNumber
NumberOfExecutions
Number of executions that will occur before the Activity will be 'Finished' after first being Activated.
(Inherited from Activity.)
OnMemberwiseClone()()()() (Inherited from ComponentBase.)
Owner
Parent who is responsible for managing this Activity. NOTE: The parent is not always the owner.
(Inherited from Activity.)
OwnerActivated(IComponentOwner) (Inherited from EntityComponent.)
OwnerDeactivated(IComponentOwner) (Inherited from EntityComponent.)
OwnerEntity (Inherited from Activity.)
OwnerOf<(Of <<'(TOwner>)>>)()()()() (Inherited from Registered.)
PrepareForUse()()()()
Attempts to prepare asset for use. To be sure, check "IsReadyForUse" after calling this method to ensure it's really ready for use before using it.
(Inherited from Asset.)
Prototype
Gets or sets the prototype, if specified, from which this asset inherits instance data.
(Inherited from Asset.)
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.
(Inherited from Activity.)
Scheduler
Scope (Inherited from Registered.)
SourceFile
Gets/Sets the source file for this program.
(Inherited from Asset.)
SpeedScalar (Inherited from Activity.)
SpeedScalarChanged
Event fires when the when the Activity SpeedScalar value is changed.
(Inherited from Activity.)
StorageModule (Inherited from Registered.)
ToString()()()() (Inherited from Activity.)
TotalDuration (Overrides Activity..::..TotalDuration.)
UniqueName (Inherited from Registered.)
Update()()()()
Updates the Activitity. Returns the FrameNumber for the next Scheduled Update. If '0 or less', this indicates that no more updates are required (or welcomed). NOTE: It is permissible for Activities to change their update rate for each new update (although it is not encouraged to be done frequently, as there may be efficiency issues.
UpdateFramesInterval
UpdateTimeInterval
WriteDiagnosticsInformation(String, String) (Inherited from Activity.)
WriteDiagnosticsInformation(Int32, String, Int32, StreamWriter) (Inherited from Activity.)

Inheritance Hierarchy

System..::..Object
  Visual3D.EntityModel..::..ComponentBase
    Visual3D.EntityModel..::..EntityComponent
      Visual3D..::..Registered
        Visual3D..::..Asset
          Visual3D..::..Activity
            Visual3D.Activities..::..ObjectUpdater

See Also