C# Class Universe.Region.Scene

Inheritance: RegistryCore, IScene

Show file Open project: Virtual-Universe/Virtual-Universe Class Usage Examples

Protected Properties

Property	Type	Description
m_UniverseEventManager	Universe.Framework.Services.ClassHelpers.Other.UniverseEventManager
m_authenticateHandler	Universe.Framework.SceneInfo.AgentCircuitManager
m_clientManager	Universe.Framework.SceneInfo.ClientManager
m_clientServers	List
m_config	IConfigSource
m_eventManager	Universe.Framework.SceneInfo.EventManager
m_lastphysupdate	System.DateTime
m_permissions	Universe.Framework.SceneInfo.ScenePermissions
m_physicstimespan	float
m_regInfo	Universe.Framework.SceneInfo.RegionInfo
m_simDataStore	ISimulationDataStore
m_updatetimespan	float

Public Methods

Method	Description
AddNewClient ( IClientAPI client, BlankHandler completed ) : void	Adding a New Client and Create a Presence for it. Called by the LLClientView when the UseCircuitCode packet comes in Used by NPCs to add themselves to the Scene
AddToStartupQueue ( string name ) : void	Add a module to the startup queue
Close ( bool killAgents ) : void	This is the method that shuts down the scene.
FinishedStartup ( string name, List data ) : void	This module finished startup and is giving a list of data about its startup
ForEachClient ( Action action ) : void
ForEachSceneEntity ( Action action ) : void
ForEachScenePresence ( Action action ) : void	Performs action on all scene presences.
GetGroupByPrim ( uint localID ) : ISceneEntity	Get a scene object group that contains the prim with the given local id
GetSceneObjectPart ( UUID ObjectID ) : ISceneChildEntity	Get a prim via its UUID
GetSceneObjectPart ( uint localID ) : ISceneChildEntity	Get a prim via its local id
GetScenePresence ( UUID agentID ) : IScenePresence	Request a scene presence by UUID. Fast, indexed lookup.
GetScenePresence ( uint agentID ) : IScenePresence
GetScenePresenceCount ( ) : int
GetScenePresences ( ) : List
Initialize ( RegionInfo regionInfo ) : void
Initialize ( RegionInfo regionInfo, ISimulationDataStore dataStore, AgentCircuitManager authen, List clientServers ) : void
RemoveAgent ( IScenePresence presence, bool forceClose ) : bool	Tell a single agent to disconnect from the region. Does not send the DisableSimulator EQM or close child agents
StartHeartbeat ( ) : void	Start the heartbeat which triggers regular scene updates
StartPhysicsScene ( ) : void	Reload the last saved physics state to the Physics Scene
StartupComplete ( IScene scene, List data ) : void	Startup is complete, trigger the modules and allow logins
StopPhysicsScene ( ) : void	Takes a state save of the Physics Scene, then clears all velocity from it so that objects stop moving
ToString ( ) : string
TryGetAvatarByName ( string avatarName, IScenePresence &avatar ) : bool
TryGetClient ( System remoteEndPoint, IClientAPI &client ) : bool
TryGetClient ( UUID avatarID, IClientAPI &client ) : bool
TryGetPart ( UUID objectUUID, ISceneChildEntity &SensedObject ) : bool
TryGetScenePresence ( UUID avatarId, IScenePresence &avatar ) : bool

Protected Methods

Method	Description
CreateAndAddChildScenePresence ( IClientAPI client ) : IScenePresence

Private Methods

Method	Description
ApproxEquals ( float a, float b, int approx ) : bool
GetHeartbeatSleepTime ( int timeBeatTook ) : int
Heartbeat ( ) : void

Method Details

AddNewClient() public method

Adding a New Client and Create a Presence for it. Called by the LLClientView when the UseCircuitCode packet comes in Used by NPCs to add themselves to the Scene

public AddNewClient ( IClientAPI client, BlankHandler completed ) : void
client	IClientAPI
completed	BlankHandler
return	void

AddToStartupQueue() public method

Add a module to the startup queue

public AddToStartupQueue ( string name ) : void
name	string
return	void

Close() public method

This is the method that shuts down the scene.

public Close ( bool killAgents ) : void
killAgents	bool
return	void

CreateAndAddChildScenePresence() protected method

protected CreateAndAddChildScenePresence ( IClientAPI client ) : IScenePresence
client	IClientAPI
return	IScenePresence

FinishedStartup() public method

This module finished startup and is giving a list of data about its startup

public FinishedStartup ( string name, List data ) : void
name	string
data	List
return	void

ForEachClient() public method

public ForEachClient ( Action action ) : void
action	Action
return	void

ForEachSceneEntity() public method

public ForEachSceneEntity ( Action action ) : void
action	Action
return	void

ForEachScenePresence() public method

Performs action on all scene presences.

public ForEachScenePresence ( Action action ) : void
action	Action
return	void

GetGroupByPrim() public method

Get a scene object group that contains the prim with the given local id

public GetGroupByPrim ( uint localID ) : ISceneEntity
localID	uint
return	ISceneEntity

GetSceneObjectPart() public method

Get a prim via its UUID

public GetSceneObjectPart ( UUID ObjectID ) : ISceneChildEntity
ObjectID	UUID
return	ISceneChildEntity

GetSceneObjectPart() public method

Get a prim via its local id

public GetSceneObjectPart ( uint localID ) : ISceneChildEntity
localID	uint
return	ISceneChildEntity

GetScenePresence() public method

Request a scene presence by UUID. Fast, indexed lookup.

public GetScenePresence ( UUID agentID ) : IScenePresence
agentID	UUID
return	IScenePresence

GetScenePresence() public method

public GetScenePresence ( uint agentID ) : IScenePresence
agentID	uint
return	IScenePresence

GetScenePresenceCount() public method

public GetScenePresenceCount ( ) : int
return	int

GetScenePresences() public method

public GetScenePresences ( ) : List
return	List

Initialize() public method

public Initialize ( RegionInfo regionInfo ) : void
regionInfo	Universe.Framework.SceneInfo.RegionInfo
return	void

Initialize() public method

public Initialize ( RegionInfo regionInfo, ISimulationDataStore dataStore, AgentCircuitManager authen, List clientServers ) : void
regionInfo	Universe.Framework.SceneInfo.RegionInfo
dataStore	ISimulationDataStore
authen	Universe.Framework.SceneInfo.AgentCircuitManager
clientServers	List
return	void

RemoveAgent() public method

Tell a single agent to disconnect from the region. Does not send the DisableSimulator EQM or close child agents

public RemoveAgent ( IScenePresence presence, bool forceClose ) : bool
presence	IScenePresence
forceClose	bool
return	bool

StartHeartbeat() public method

Start the heartbeat which triggers regular scene updates

public StartHeartbeat ( ) : void
return	void

StartPhysicsScene() public method

Reload the last saved physics state to the Physics Scene

public StartPhysicsScene ( ) : void
return	void

StartupComplete() public method

Startup is complete, trigger the modules and allow logins

public StartupComplete ( IScene scene, List data ) : void
scene	IScene
data	List
return	void

StopPhysicsScene() public method

Takes a state save of the Physics Scene, then clears all velocity from it so that objects stop moving

public StopPhysicsScene ( ) : void
return	void

ToString() public method

public ToString ( ) : string
return	string

TryGetAvatarByName() public method

public TryGetAvatarByName ( string avatarName, IScenePresence &avatar ) : bool
avatarName	string
avatar	IScenePresence
return	bool

TryGetClient() public method

public TryGetClient ( System remoteEndPoint, IClientAPI &client ) : bool
remoteEndPoint	System
client	IClientAPI
return	bool

TryGetClient() public method

public TryGetClient ( UUID avatarID, IClientAPI &client ) : bool
avatarID	UUID
client	IClientAPI
return	bool

TryGetPart() public method

public TryGetPart ( UUID objectUUID, ISceneChildEntity &SensedObject ) : bool
objectUUID	UUID
SensedObject	ISceneChildEntity
return	bool

TryGetScenePresence() public method

public TryGetScenePresence ( UUID avatarId, IScenePresence &avatar ) : bool
avatarId	UUID
avatar	IScenePresence
return	bool

Property Details

m_UniverseEventManager protected property

protected UniverseEventManager,Universe.Framework.Services.ClassHelpers.Other m_UniverseEventManager
return	Universe.Framework.Services.ClassHelpers.Other.UniverseEventManager

m_authenticateHandler protected property

protected AgentCircuitManager,Universe.Framework.SceneInfo m_authenticateHandler
return	Universe.Framework.SceneInfo.AgentCircuitManager

m_clientManager protected property

protected ClientManager,Universe.Framework.SceneInfo m_clientManager
return	Universe.Framework.SceneInfo.ClientManager

m_clientServers protected property

protected List m_clientServers
return	List

m_config protected property

protected IConfigSource m_config
return	IConfigSource

m_eventManager protected property

protected EventManager,Universe.Framework.SceneInfo m_eventManager
return	Universe.Framework.SceneInfo.EventManager

m_lastphysupdate protected property

protected DateTime,System m_lastphysupdate
return	System.DateTime

m_permissions protected property

protected ScenePermissions,Universe.Framework.SceneInfo m_permissions
return	Universe.Framework.SceneInfo.ScenePermissions

m_physicstimespan protected property

protected float m_physicstimespan
return	float

m_regInfo protected property

protected RegionInfo,Universe.Framework.SceneInfo m_regInfo
return	Universe.Framework.SceneInfo.RegionInfo

m_simDataStore protected property

protected ISimulationDataStore m_simDataStore
return	ISimulationDataStore

m_updatetimespan protected property

protected float m_updatetimespan
return	float