alternativa.engine3d.core.Sector

Package	alternativa.engine3d.core
Class	public class Sector

Sectors provide a mechanism to control visibility of different scene parts in addition to splitters system. Each sector is located in one of the BSP-tree branches, which have been created by splitters. Also, every sector stores a set of other sectors, which are potentially visible from it.

If a camera is located in a child branch of a tree node, formed by a splitter, then visibility of the other branch of that node is determined by the following rules:

If the branch in which the camera is located doesn't contain a sector, then visibility of the neighbor branch is determined by the state of the splitter.
If the branch in which the camera is located doesn't contain a sector and the neighbor branch contains a sector, then visibility of the neighbor branch is determined by the state of the splitter.
If both branches contain sectors, then visibility of the neighbor branch is determined by the state of the splitter and mutual visibility of the sectors. This means that if sectors are not visible to each other, then the neighbor branch won't be visible regardless the splitter's state.

Sectors are specified in the Scene.sectors property.

See also

Scene3D.sectors
Splitter

	Property	Defined by
		name : String The name of the sector.	Sector

	Method	Defined by
		Sector(x:Number = 0, y:Number = 0, z:Number = 0, name:String = null) Creates a new instance of a sector.	Sector
		addVisible(sector:Sector, ... sectors):void Adds the specified sectors to the visibility list.	Sector
		isVisible(sector:Sector):Boolean Determines potential visibility of the specified sector.	Sector
		removeVisible(sector:Sector, ... sectors):void Removes the specified sectors from the visibility list.	Sector
		toString():String Creates a string representation of an object.	Sector

Property detail

name

property

public var name:String

The name of the sector.

Constructor detail

Sector

()

constructor

public function Sector(x:Number = 0, y:Number = 0, z:Number = 0, name:String = null)

Creates a new instance of a sector. Specified coordinates determine the child branch of a splitter, in which the sector will be located.

Parameters

	`x:Number` (default = `0`) — X coordinate

	`y:Number` (default = `0`) — Y coordinate

	`z:Number` (default = `0`) — Z coordinate

	`name:String` (default = `null`) — the name of the sector. If `null` have been specified, the name will be generated automatically.

Method detail

addVisible

()

method

public function addVisible(sector:Sector, ... sectors):void

Adds the specified sectors to the visibility list. The visibility of sectors is mutual, therefore the current sector is automatically added to visibility list of each specified sector.

Parameters

	`sector:Sector` — the sector to add to the visibility list

	`... sectors` — additional sectors to add to the visibility list

See also

removeVisible()

isVisible

()

method

public function isVisible(sector:Sector):Boolean

Determines potential visibility of the specified sector.

Parameters

sector:Sector — sector whose visibility is checked

Returns

Boolean — true, if the specified sector is in the visibility list, otherwise false

removeVisible

()

method

public function removeVisible(sector:Sector, ... sectors):void

Removes the specified sectors from the visibility list. The visibility of sectors is mutual, therefore the current sector is automatically removed from visibility list of each specified sector.

Parameters

	`sector:Sector` — the sector to delete from the visibility list

	`... sectors` — additional sectors to remove from the visibility list

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class Sector	Properties \| Methods