C# Class OpenMetaverse.Simulator

Inheritance: UDPBase, IDisposable
Show file Open project: 3di/3di-viewer-rei-libs Class Usage Examples

Public Properties

Property Type Description
Access SimAccess
BillableFactor float
Caps Caps
Client GridClient
Estate EstateTools
Flags RegionFlags
Handle ulong
ID UUID
IsEstateManager bool
Name string
ObjectsAvatars Avatar>.InternalDictionary
ObjectsPrimitives Primitive>.InternalDictionary
ParcelOverlay byte[]
ParcelOverlaysReceived int
Parcels Parcel>.InternalDictionary
Sequence SequenceNumberCounter
SimOwner UUID
SimVersion string
Stats SimStats
TerrainBase0 UUID
TerrainBase1 UUID
TerrainBase2 UUID
TerrainBase3 UUID
TerrainDetail0 UUID
TerrainDetail1 UUID
TerrainDetail2 UUID
TerrainDetail3 UUID
TerrainHeightRange00 float
TerrainHeightRange01 float
TerrainHeightRange10 float
TerrainHeightRange11 float
TerrainStartHeight00 float
TerrainStartHeight01 float
TerrainStartHeight10 float
TerrainStartHeight11 float
WaterHeight float

Public Methods

Method Description
Connect ( bool moveToSim ) : bool

Attempt to connect to this simulator
Disconnect ( bool sendCloseCircuit ) : void

Disconnect from this simulator
Dispose ( ) : void

Called when this Simulator object is being destroyed
Equals ( object obj ) : bool

GetHashCode ( ) : int

IsParcelMapFull ( ) : bool

Checks simulator parcel map to make sure it has downloaded all data successfully
Pause ( ) : void

Instructs the simulator to stop sending update (and possibly other) packets
Resume ( ) : void

Instructs the simulator to resume sending update packets (unpause)
SendPacket ( NetworkManager outgoingPacket ) : void

Sends a packet
SendPacket ( Packet packet, bool setSequence ) : void

Sends a packet
SendPacketUnqueued ( NetworkManager outgoingPacket ) : void

Sends a packet directly to the simulator without queuing
SendPacketUnqueued ( byte payload, bool setSequence ) : void

Send a raw byte array payload as a packet
SendPing ( ) : void

SetSeedCaps ( string seedcaps ) : void
Simulator ( GridClient client, IPEndPoint address, ulong handle ) : System

ToString ( ) : string

Returns Simulator Name as a String
operator ( ) : bool

Protected Methods

Method Description
PacketReceived ( UDPPacketBuffer buffer ) : void
PacketSent ( UDPPacketBuffer buffer, int bytesSent ) : void

Private Methods

Method Description
AckTimer_Elapsed ( object obj ) : void
PingTimer_Elapsed ( object obj ) : void
ResendUnacked ( ) : void

Resend unacknowledged packets
SendAcks ( ) : void

Sends out pending acknowledgements
StatsTimer_Elapsed ( object obj ) : void

Method Details

Connect() public method

Attempt to connect to this simulator
public Connect ( bool moveToSim ) : bool
moveToSim bool Whether to move our agent in to this sim or not
return bool

Disconnect() public method

Disconnect from this simulator
public Disconnect ( bool sendCloseCircuit ) : void
sendCloseCircuit bool
return void

Dispose() public method

Called when this Simulator object is being destroyed
public Dispose ( ) : void
return void

Equals() public method

public Equals ( object obj ) : bool
obj object
return bool

GetHashCode() public method

public GetHashCode ( ) : int
return int

IsParcelMapFull() public method

Checks simulator parcel map to make sure it has downloaded all data successfully
public IsParcelMapFull ( ) : bool
return bool

PacketReceived() protected method

protected PacketReceived ( UDPPacketBuffer buffer ) : void
buffer UDPPacketBuffer
return void

PacketSent() protected method

protected PacketSent ( UDPPacketBuffer buffer, int bytesSent ) : void
buffer UDPPacketBuffer
bytesSent int
return void

Pause() public method

Instructs the simulator to stop sending update (and possibly other) packets
public Pause ( ) : void
return void

Resume() public method

Instructs the simulator to resume sending update packets (unpause)
public Resume ( ) : void
return void

SendPacket() public method

Sends a packet
public SendPacket ( NetworkManager outgoingPacket ) : void
outgoingPacket NetworkManager Packet to be sent
return void

SendPacket() public method

Sends a packet
public SendPacket ( Packet packet, bool setSequence ) : void
packet Packet Packet to be sent
setSequence bool True to set the sequence number, false to /// leave it as is
return void

SendPacketUnqueued() public method

Sends a packet directly to the simulator without queuing
public SendPacketUnqueued ( NetworkManager outgoingPacket ) : void
outgoingPacket NetworkManager Packet to be sent
return void

SendPacketUnqueued() public method

Send a raw byte array payload as a packet
public SendPacketUnqueued ( byte payload, bool setSequence ) : void
payload byte The packet payload
setSequence bool Whether the second, third, and fourth bytes /// should be modified to the current stream sequence number
return void

SendPing() public method

public SendPing ( ) : void
return void

SetSeedCaps() public method

public SetSeedCaps ( string seedcaps ) : void
seedcaps string
return void

Simulator() public method

public Simulator ( GridClient client, IPEndPoint address, ulong handle ) : System
client GridClient Reference to the GridClient object
address IPEndPoint IPEndPoint of the simulator
handle ulong handle of the simulator
return System

ToString() public method

Returns Simulator Name as a String
public ToString ( ) : string
return string

operator() public static method

public static operator ( ) : bool
return bool

Property Details

Access public property

public SimAccess Access
return SimAccess

BillableFactor public property

public float BillableFactor
return float

Caps public property

The capabilities for this simulator
public Caps,OpenMetaverse Caps
return Caps

Client public property

A public reference to the client that this Simulator object is attached to
public GridClient,OpenMetaverse Client
return GridClient

Estate public property

public EstateTools Estate
return EstateTools

Flags public property

public RegionFlags Flags
return RegionFlags

Handle public property

public ulong Handle
return ulong

ID public property

public UUID ID
return UUID

IsEstateManager public property

public bool IsEstateManager
return bool

Name public property

public string Name
return string

ObjectsAvatars public property

Provides access to two thread-safe dictionaries containing avatars and primitives found in this simulator
public InternalDictionary ObjectsAvatars
return Avatar>.InternalDictionary

ObjectsPrimitives public property

public InternalDictionary ObjectsPrimitives
return Primitive>.InternalDictionary

ParcelOverlay public property

A 64x64 grid of parcel coloring values. The values stored in this array are of the ParcelArrayType type
public byte[] ParcelOverlay
return byte[]

ParcelOverlaysReceived public property

public int ParcelOverlaysReceived
return int

Parcels public property

Provides access to an internal thread-safe dictionary containing parcel information found in this simulator
public InternalDictionary Parcels
return Parcel>.InternalDictionary

Sequence public property

The current sequence number for packets sent to this simulator. Must be Interlocked before modifying. Only useful for applications manipulating sequence numbers
public SequenceNumberCounter Sequence
return SequenceNumberCounter

SimOwner public property

public UUID SimOwner
return UUID

SimVersion public property

The current version of software this simulator is running
public string SimVersion
return string

Stats public property

Statistics information for this simulator and the connection to the simulator, calculated by the simulator itself and the library
public SimStats Stats
return SimStats

TerrainBase0 public property

public UUID TerrainBase0
return UUID

TerrainBase1 public property

public UUID TerrainBase1
return UUID

TerrainBase2 public property

public UUID TerrainBase2
return UUID

TerrainBase3 public property

public UUID TerrainBase3
return UUID

TerrainDetail0 public property

public UUID TerrainDetail0
return UUID

TerrainDetail1 public property

public UUID TerrainDetail1
return UUID

TerrainDetail2 public property

public UUID TerrainDetail2
return UUID

TerrainDetail3 public property

public UUID TerrainDetail3
return UUID

TerrainHeightRange00 public property

public float TerrainHeightRange00
return float

TerrainHeightRange01 public property

public float TerrainHeightRange01
return float

TerrainHeightRange10 public property

public float TerrainHeightRange10
return float

TerrainHeightRange11 public property

public float TerrainHeightRange11
return float

TerrainStartHeight00 public property

public float TerrainStartHeight00
return float

TerrainStartHeight01 public property

public float TerrainStartHeight01
return float

TerrainStartHeight10 public property

public float TerrainStartHeight10
return float

TerrainStartHeight11 public property

public float TerrainStartHeight11
return float

WaterHeight public property

public float WaterHeight
return float