OpenSim.Framework.ILandObject Interface Reference

Inheritance diagram for OpenSim.Framework.ILandObject:

Public Member Functions
int	GetParcelMaxPrimCount ()
int	GetSimulatorMaxPrimCount ()
int	GetPrimsFree ()
Dictionary< UUID, int >	GetLandObjectOwners ()
Vector2	GetNearestPoint (Vector3 pos)
Vector2	GetNearestPointAlongDirection (Vector3 pos, Vector3 pdirection)
bool	ContainsPoint (int x, int y)
ILandObject	Copy ()
void	SendLandUpdateToAvatarsOverMe ()
void	SendLandProperties (int sequence_id, bool snap_selection, int request_result, IClientAPI remote_client)
bool	UpdateLandProperties (LandUpdateArgs args, IClientAPI remote_client, out bool snap_selection, out bool needOverlay)
bool	IsEitherBannedOrRestricted (UUID avatar)
bool	IsBannedFromLand (UUID avatar)
bool	CanBeOnThisLand (UUID avatar, float posHeight)
bool	IsRestrictedFromLand (UUID avatar)
bool	IsInLandAccessList (UUID avatar)
void	SendLandUpdateToClient (IClientAPI remote_client)
void	SendLandUpdateToClient (bool snap_selection, IClientAPI remote_client)
List< LandAccessEntry >	CreateAccessListArrayByFlag (AccessList flag)
void	SendAccessList (UUID agentID, UUID sessionID, uint flags, int sequenceID, IClientAPI remote_client)
void	UpdateAccessList (uint flags, UUID transactionID, int sequenceID, int sections, List< LandAccessEntry > entries, IClientAPI remote_client)
void	UpdateLandBitmapByteArray ()
void	SetLandBitmapFromByteArray ()
bool[,]	GetLandBitmap ()
void	ForceUpdateLandInfo ()
void	SetLandBitmap (bool[,] bitmap)
bool[,]	BasicFullRegionLandBitmap ()
	Get a land bitmap that would cover an entire region. More...
bool[,]	GetSquareLandBitmap (int start_x, int start_y, int end_x, int end_y, bool set_value=true)
	Create a square land bitmap. More...
bool[,]	ModifyLandBitmapSquare (bool[,] land_bitmap, int start_x, int start_y, int end_x, int end_y, bool set_value)
bool[,]	MergeLandBitmaps (bool[,] bitmap_base, bool[,] bitmap_add)
	Merge two (same size) land bitmaps. More...
bool[,]	RemapLandBitmap (bool[,] bitmap_base, Vector2 displacement, float rotationDegrees, Vector2 boundingOrigin, Vector2 boundingSize, Vector2 regionSize, out bool isEmptyNow, out Vector3 AABBMin, out Vector3 AABBMax)
	Remap a land bitmap. Takes the supplied land bitmap and rotates it, crops it and finally offsets it into a final land bitmap of the target region size. More...
bool[,]	RemoveFromLandBitmap (bool[,] bitmap_base, bool[,] bitmap_new, out bool isEmptyNow, out Vector3 AABBMin, out Vector3 AABBMax)
	Clears any parcel data in bitmap_base where there exists parcel data in bitmap_new. In other words the parcel data in bitmap_new takes over the space of the parcel data in bitmap_base. More...
byte[]	ConvertLandBitmapToBytes ()
bool[,]	ConvertBytesToLandBitmap (bool overrideRegionSize=false)
bool	IsLandBitmapEmpty (bool[,] landBitmap)
void	DebugLandBitmap (bool[,] landBitmap)
void	SendForceObjectSelect (int local_id, int request_type, List< UUID > returnIDs, IClientAPI remote_client)
void	SendLandObjectOwners (IClientAPI remote_client)
void	ReturnLandObjects (uint type, UUID[] owners, UUID[] tasks, IClientAPI remote_client)
void	ResetOverMeRecord ()
void	UpdateLandSold (UUID avatarID, UUID groupID, bool groupOwned, uint AuctionID, int claimprice, int area)
void	DeedToGroup (UUID groupID)
void	SetParcelObjectMaxOverride (overrideParcelMaxPrimCountDelegate overrideDel)
void	SetSimulatorObjectMaxOverride (overrideSimulatorMaxPrimCountDelegate overrideDel)
void	SetMediaUrl (string url)
	Set the media url for this land parcel More...
void	SetMusicUrl (string url)
	Set the music url for this land parcel More...
string	GetMusicUrl ()
	Get the music url for this land parcel More...

Properties
LandData	LandData [get, set]
bool[,]	LandBitmap [get, set]
UUID	RegionUUID [get]
IPrimCounts	PrimCounts [get, set]
	Prim counts for this land object. More...
Vector2	StartPoint [get]
	The start point for the land object. This is the northern-most point as one scans land working from west to east. More...
Vector2	EndPoint [get]
	The end point for the land object. This is the southern-most point as one scans land working from west to east. More...
Vector2	CenterPoint [get]

Detailed Description

Definition at line 36 of file ILandObject.cs.

Member Function Documentation

bool [,] OpenSim.Framework.ILandObject.BasicFullRegionLandBitmap

(

)

Get a land bitmap that would cover an entire region.

Returns

The bitmap created.

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

bool OpenSim.Framework.ILandObject.CanBeOnThisLand	(	UUID	avatar,
		float	posHeight
	)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

bool OpenSim.Framework.ILandObject.ContainsPoint	(	int	x,
		int	y
	)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

Here is the caller graph for this function:

bool [,] OpenSim.Framework.ILandObject.ConvertBytesToLandBitmap

(

bool

overrideRegionSize = false

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

byte [] OpenSim.Framework.ILandObject.ConvertLandBitmapToBytes

(

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

ILandObject OpenSim.Framework.ILandObject.Copy

(

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

List<LandAccessEntry> OpenSim.Framework.ILandObject.CreateAccessListArrayByFlag

(

AccessList

flag

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.DebugLandBitmap

(

bool

landBitmap[,]

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.DeedToGroup

(

UUID

groupID

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.ForceUpdateLandInfo

(

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

bool [,] OpenSim.Framework.ILandObject.GetLandBitmap

(

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

Here is the caller graph for this function:

Dictionary<UUID, int> OpenSim.Framework.ILandObject.GetLandObjectOwners

(

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

string OpenSim.Framework.ILandObject.GetMusicUrl

(

)

Get the music url for this land parcel

Returns

The music url.

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

Vector2 OpenSim.Framework.ILandObject.GetNearestPoint

(

Vector3

pos

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

Vector2 OpenSim.Framework.ILandObject.GetNearestPointAlongDirection	(	Vector3	pos,
		Vector3	pdirection
	)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

int OpenSim.Framework.ILandObject.GetParcelMaxPrimCount

(

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

int OpenSim.Framework.ILandObject.GetPrimsFree

(

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

int OpenSim.Framework.ILandObject.GetSimulatorMaxPrimCount

(

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

bool [,] OpenSim.Framework.ILandObject.GetSquareLandBitmap	(	int	start_x,
		int	start_y,
		int	end_x,
		int	end_y,
		bool	set_value = true
	)

Create a square land bitmap.

Land co-ordinates are zero indexed. The inputs are treated as points. So if you want to create a bitmap that covers an entire 256 x 256m region apart from a strip of land on the east, then you would need to specify start_x = 0, start_y = 0, end_x = 252 (or anything up to 255), end_y = 255.

At the moment, the smallest parcel of land is 4m x 4m, so if the region is 256 x 256m (the SL size), the bitmap returned will start at (0,0) and end at (63,63). The value of the set_value needs to be true to define an active parcel of the given size.

Parameters

start_x
start_y
end_x
end_y
set_value

Returns

The bitmap created.

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

bool OpenSim.Framework.ILandObject.IsBannedFromLand

(

UUID

avatar

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

Here is the caller graph for this function:

bool OpenSim.Framework.ILandObject.IsEitherBannedOrRestricted

(

UUID

avatar

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

Here is the caller graph for this function:

bool OpenSim.Framework.ILandObject.IsInLandAccessList

(

UUID

avatar

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

Here is the caller graph for this function:

bool OpenSim.Framework.ILandObject.IsLandBitmapEmpty

(

bool

landBitmap[,]

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

bool OpenSim.Framework.ILandObject.IsRestrictedFromLand

(

UUID

avatar

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

Here is the caller graph for this function:

bool [,] OpenSim.Framework.ILandObject.MergeLandBitmaps	(	bool	bitmap_base[,],
		bool	bitmap_add[,]
	)

Merge two (same size) land bitmaps.

Parameters

bitmap_base
bitmap_add

Returns

The modified bitmap.

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

bool [,] OpenSim.Framework.ILandObject.ModifyLandBitmapSquare	(	bool	land_bitmap[,],
		int	start_x,
		int	start_y,
		int	end_x,
		int	end_y,
		bool	set_value
	)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

bool [,] OpenSim.Framework.ILandObject.RemapLandBitmap	(	bool	bitmap_base[,],
		Vector2	displacement,
		float	rotationDegrees,
		Vector2	boundingOrigin,
		Vector2	boundingSize,
		Vector2	regionSize,
		out bool	isEmptyNow,
		out Vector3	AABBMin,
		out Vector3	AABBMax
	)

Remap a land bitmap. Takes the supplied land bitmap and rotates it, crops it and finally offsets it into a final land bitmap of the target region size.

Parameters

bitmap_base	The original parcel bitmap
rotationDegrees
displacement	<x,y,?>
boundingOrigin	<x,y,?>
boundingSize	<x,y,?>
regionSize	<x,y,?>
isEmptyNow	out: This is set if the resultant bitmap is now empty
AABBMin	out: parcel.AABBMin <x,y,0&gt
AABBMax	out: parcel.AABBMax <x,y,0&gt

Returns

New parcel bitmap

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

bool [,] OpenSim.Framework.ILandObject.RemoveFromLandBitmap	(	bool	bitmap_base[,],
		bool	bitmap_new[,],
		out bool	isEmptyNow,
		out Vector3	AABBMin,
		out Vector3	AABBMax
	)

Clears any parcel data in bitmap_base where there exists parcel data in bitmap_new. In other words the parcel data in bitmap_new takes over the space of the parcel data in bitmap_base.

Parameters

bitmap_base
bitmap_new
isEmptyNow	out: This is set if the resultant bitmap is now empty
AABBMin	out: parcel.AABBMin <x,y,0>
AABBMax	out: parcel.AABBMax <x,y,0&gt

Returns

New parcel bitmap

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.ResetOverMeRecord

(

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.ReturnLandObjects	(	uint	type,
		UUID[]	owners,
		UUID[]	tasks,
		IClientAPI	remote_client
	)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.SendAccessList	(	UUID	agentID,
		UUID	sessionID,
		uint	flags,
		int	sequenceID,
		IClientAPI	remote_client
	)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.SendForceObjectSelect	(	int	local_id,
		int	request_type,
		List< UUID >	returnIDs,
		IClientAPI	remote_client
	)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.SendLandObjectOwners

(

IClientAPI

remote_client

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.SendLandProperties	(	int	sequence_id,
		bool	snap_selection,
		int	request_result,
		IClientAPI	remote_client
	)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

Here is the caller graph for this function:

void OpenSim.Framework.ILandObject.SendLandUpdateToAvatarsOverMe

(

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.SendLandUpdateToClient

(

IClientAPI

remote_client

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.SendLandUpdateToClient	(	bool	snap_selection,
		IClientAPI	remote_client
	)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.SetLandBitmap

(

bool

bitmap[,]

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.SetLandBitmapFromByteArray

(

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.SetMediaUrl

(

string

url

)

Set the media url for this land parcel

Parameters

url

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.SetMusicUrl

(

string

url

)

Set the music url for this land parcel

Parameters

url

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.SetParcelObjectMaxOverride

(

overrideParcelMaxPrimCountDelegate

overrideDel

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.SetSimulatorObjectMaxOverride

(

overrideSimulatorMaxPrimCountDelegate

overrideDel

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.UpdateAccessList	(	uint	flags,
		UUID	transactionID,
		int	sequenceID,
		int	sections,
		List< LandAccessEntry >	entries,
		IClientAPI	remote_client
	)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

void OpenSim.Framework.ILandObject.UpdateLandBitmapByteArray

(

)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

bool OpenSim.Framework.ILandObject.UpdateLandProperties	(	LandUpdateArgs	args,
		IClientAPI	remote_client,
		out bool	snap_selection,
		out bool	needOverlay
	)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

Here is the caller graph for this function:

void OpenSim.Framework.ILandObject.UpdateLandSold	(	UUID	avatarID,
		UUID	groupID,
		bool	groupOwned,
		uint	AuctionID,
		int	claimprice,
		int	area
	)

Implemented in OpenSim.Region.CoreModules.World.Land.LandObject.

Property Documentation

Vector2 OpenSim.Framework.ILandObject.CenterPoint

get

Definition at line 65 of file ILandObject.cs.

Vector2 OpenSim.Framework.ILandObject.EndPoint

get

The end point for the land object. This is the southern-most point as one scans land working from west to east.

Definition at line 62 of file ILandObject.cs.

bool [,] OpenSim.Framework.ILandObject.LandBitmap

getset

Definition at line 44 of file ILandObject.cs.

LandData OpenSim.Framework.ILandObject.LandData

getset

Definition at line 43 of file ILandObject.cs.

IPrimCounts OpenSim.Framework.ILandObject.PrimCounts

getset

Prim counts for this land object.

Definition at line 50 of file ILandObject.cs.

UUID OpenSim.Framework.ILandObject.RegionUUID

get

Definition at line 45 of file ILandObject.cs.

Vector2 OpenSim.Framework.ILandObject.StartPoint

get

The start point for the land object. This is the northern-most point as one scans land working from west to east.

Definition at line 56 of file ILandObject.cs.

---

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

• Framework/ILandObject.cs