OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Protected Attributes | Properties | List of all members
OpenSim.Region.Framework.Scenes.CoalescedSceneObjects Class Reference

Represents a coalescene of scene objects. A coalescence occurs when objects that are not in the same linkset are grouped together. More...

Public Member Functions

 CoalescedSceneObjects (UUID creatorId)
 
 CoalescedSceneObjects (UUID creatorId, params SceneObjectGroup[] objs)
 
void Add (SceneObjectGroup obj)
 Add an object to the coalescence. More...
 
bool Remove (SceneObjectGroup obj)
 Removes a scene object from the coalescene More...
 
Vector3[] GetSizeAndOffsets (out Vector3 size)
 Get the total size of the coalescence (the size required to cover all the objects within it) and the offsets of each of those objects. More...
 

Protected Attributes

List< SceneObjectGroupm_memberObjects = new List<SceneObjectGroup>()
 At this point, we need to preserve the order of objects added to the coalescence, since the first one will end up matching the item name when rerezzed. More...
 

Properties

UUID CreatorId [get, set]
 The creator of this coalesence, though not necessarily the objects within it. More...
 
int Count [get]
 The number of objects in this coalesence More...
 
bool HasObjects [get]
 Does this coalesence have any member objects? More...
 
List< SceneObjectGroupObjects [get]
 Get the objects currently in this coalescence More...
 
Scene Scene [get]
 Get the scene that contains the objects in this coalescence. If there are no objects then null is returned. More...
 

Detailed Description

Represents a coalescene of scene objects. A coalescence occurs when objects that are not in the same linkset are grouped together.

Definition at line 39 of file CoalescedSceneObjects.cs.

Constructor & Destructor Documentation

OpenSim.Region.Framework.Scenes.CoalescedSceneObjects.CoalescedSceneObjects ( UUID  creatorId)
inline

Definition at line 95 of file CoalescedSceneObjects.cs.

OpenSim.Region.Framework.Scenes.CoalescedSceneObjects.CoalescedSceneObjects ( UUID  creatorId,
params SceneObjectGroup[]  objs 
)
inline

Definition at line 100 of file CoalescedSceneObjects.cs.

Member Function Documentation

void OpenSim.Region.Framework.Scenes.CoalescedSceneObjects.Add ( SceneObjectGroup  obj)
inline

Add an object to the coalescence.

Parameters
obj
offsetThe offset of the object within the group

Definition at line 111 of file CoalescedSceneObjects.cs.

Vector3 [] OpenSim.Region.Framework.Scenes.CoalescedSceneObjects.GetSizeAndOffsets ( out Vector3  size)
inline

Get the total size of the coalescence (the size required to cover all the objects within it) and the offsets of each of those objects.

Parameters
size
Returns
An array of offsets. The order of objects is the same as returned from the Objects property

Definition at line 136 of file CoalescedSceneObjects.cs.

bool OpenSim.Region.Framework.Scenes.CoalescedSceneObjects.Remove ( SceneObjectGroup  obj)
inline

Removes a scene object from the coalescene

Parameters
sceneObjectId
Returns
true if the object was there to be removed, false if not.

Definition at line 122 of file CoalescedSceneObjects.cs.

Member Data Documentation

List<SceneObjectGroup> OpenSim.Region.Framework.Scenes.CoalescedSceneObjects.m_memberObjects = new List<SceneObjectGroup>()
protected

At this point, we need to preserve the order of objects added to the coalescence, since the first one will end up matching the item name when rerezzed.

Definition at line 93 of file CoalescedSceneObjects.cs.

Property Documentation

int OpenSim.Region.Framework.Scenes.CoalescedSceneObjects.Count
get

The number of objects in this coalesence

Definition at line 50 of file CoalescedSceneObjects.cs.

UUID OpenSim.Region.Framework.Scenes.CoalescedSceneObjects.CreatorId
getset

The creator of this coalesence, though not necessarily the objects within it.

Definition at line 44 of file CoalescedSceneObjects.cs.

bool OpenSim.Region.Framework.Scenes.CoalescedSceneObjects.HasObjects
get

Does this coalesence have any member objects?

Definition at line 61 of file CoalescedSceneObjects.cs.

List<SceneObjectGroup> OpenSim.Region.Framework.Scenes.CoalescedSceneObjects.Objects
get

Get the objects currently in this coalescence

Definition at line 67 of file CoalescedSceneObjects.cs.

Scene OpenSim.Region.Framework.Scenes.CoalescedSceneObjects.Scene
get

Get the scene that contains the objects in this coalescence. If there are no objects then null is returned.

Definition at line 79 of file CoalescedSceneObjects.cs.


The documentation for this class was generated from the following file: