laya.d3.terrain.Terrain

	Property	Defined By
		active : Boolean 获取自身是否激活。	Sprite3D
		activeInHierarchy : Boolean [read-only] 获取在场景中是否激活。	Sprite3D
		componentsCount : int [read-only] 获得组件的数量。	Sprite3D
		destroyed : Boolean [只读]是否已经销毁。对象销毁后不能再使用。	Node
		displayedInStage : Boolean [read-only] 表示是否在显示列表中显示。	Node
		id : int [read-only] 获取唯一标识ID。	Sprite3D
		isStatic : Boolean 是否静态,静态包含一系列的静态处理。	Sprite3D
		layer : Layer 获取蒙版。	Sprite3D
		loaded : Boolean [read-only] 获取是否已加载完成。	Sprite3D
		LOD_DISTANCE_FACTOR : Number = 2.0 [static]	Terrain
		LOD_TOLERANCE_VALUE : Number = 4 [static]	Terrain
		name : String 节点名称。	Node
		numChildren : int [read-only] 子对象数量。	Node
		parent : Node 父节点。	Node
		RENDER_LINE_MODEL : Boolean = false [static]	Terrain
		scene : Scene [read-only] 获得所属场景。	Sprite3D
		terrainRes : TerrainRes [write-only]	Terrain
		timer : Timer 时间控制器，默认为Laya.timer。	Node
		transform : Transform3D [read-only] 获取精灵变换。	Sprite3D
		url : String 获取资源的URL地址。	Sprite3D
		__VECTOR3__ : Vector3 [static]	Terrain

Public Methods

	Method		Defined By
		Terrain(terrainRes:TerrainRes = null) 创建一个 MeshSprite3D 实例。	Terrain
		_getSortID(renderElement:IRenderable, material:BaseMaterial):int 排序函数。	Sprite3D
		_update(state:RenderState):void 更新	Sprite3D
		_updateConch(state:RenderState):void 更新	Sprite3D
		addChild(node:Node):Node [override] 添加子节点。	Sprite3D
		addChildAt(node:Node, index:int):Node [override] 添加子节点到指定的索引位置。	Sprite3D
		addChildren(... args):void 批量增加子节点	Node
		addComponent(type:*):Component3D 添加指定类型组件。	Sprite3D
		buildTerrain(terrainRes:TerrainRes):void	Terrain
		clearTimer(caller:*, method:Function):void 清理定时器。功能同Laya.timer.clearTimer()。	Node
		clone():* 克隆。	Sprite3D
		cloneTo(destObject:*):void 克隆。	Sprite3D
		contains(node:Node):Boolean 当前容器是否包含指定的 Node 节点对象。	Node
		depth():Number 获取地形Z轴长度。	Terrain
		destroy(destroyChild:Boolean = true):void [override] 销毁此对象。destroy对象默认会把自己从父节点移除，并且清理自身引用关系，等待js自动垃圾回收机制回收。destroy后不能再使用。 destroy时会移除自身的事情监听，自身的timer监听，移除子对象及从父节点移除自己。	Sprite3D
		destroyChildren():void 销毁所有子对象，不销毁自己本身。	Node
		disableLight():void	Terrain
		event(type:String, data:* = null):Boolean 派发事件。	EventDispatcher
		frameLoop(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true):void 定时重复执行某函数(基于帧率)。功能同Laya.timer.frameLoop()。	Node
		frameOnce(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true):void 定时执行一次某函数(基于帧率)。功能同Laya.timer.frameOnce()。	Node
		getChildAt(index:int):Node 根据子节点的索引位置，获取子节点对象。	Node
		getChildByName(name:String):Node 根据子节点的名字，获取子节点对象。	Node
		getChildIndex(node:Node):int 根据子节点对象，获取子节点的索引位置。	Node
		getComponentByIndex(index:int):Component3D 通过指定索引获得组件。	Sprite3D
		getComponentByType(type:*, typeIndex:int = 0):Component3D 通过指定类型和类型索引获得组件。	Sprite3D
		getComponentsByType(type:*, components:Vector.<Component3D>):void 通过指定类型获得所有组件。	Sprite3D
		getHeightXZ(x:Number, z:Number):Number 获取地形高度。	Terrain
		getProjectionViewWorldMatrix(projectionViewMatrix:Matrix4x4):Matrix4x4 获取投影视图世界矩阵。	Sprite3D
		hasListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	EventDispatcher
		instantiate(original:Sprite3D, parent:Node = null, worldPositionStays:Boolean = true, position:Vector3 = null, rotation:Quaternion = null):Sprite3D [static] 创建精灵的克隆实例。	Sprite3D
		isMouseEvent(type:String):Boolean 检测指定事件类型是否是鼠标事件。	EventDispatcher
		load(url:String):Terrain [static] 加载网格模板,注意:不缓存。	Terrain
		loadHierarchy(url:String):void 加载层级文件，并作为该节点的子节点。	Sprite3D
		off(type:String, caller:*, listener:Function, onceOnly:Boolean = false):EventDispatcher 从 EventDispatcher 对象中删除侦听器。	EventDispatcher
		offAll(type:String = null):EventDispatcher 从 EventDispatcher 对象中删除指定事件类型的所有侦听器。	EventDispatcher
		on(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher [override] 增加事件侦听器，以使侦听器能够接收事件通知。如果侦听鼠标事件，则会自动设置自己和父亲节点的属性 mouseEnabled 的值为 true(如果父节点mouseEnabled=false，则停止设置父节点mouseEnabled属性)。	Node
		onAsynLoaded(url:String, data:*, params:Array):void private	Sprite3D
		once(type:String, caller:*, listener:Function, args:Array = null):EventDispatcher [override] 增加事件侦听器，以使侦听器能够接收事件通知，此侦听事件响应一次后则自动移除侦听。如果侦听鼠标事件，则会自动设置自己和父亲节点的属性 mouseEnabled 的值为 true(如果父节点mouseEnabled=false，则停止设置父节点mouseEnabled属性)。	Node
		removeAllComponent():void 移除全部组件。	Sprite3D
		removeChild(node:Node):Node 删除子节点。	Node
		removeChildAt(index:int):Node [override] 根据子节点索引位置，删除对应的子节点对象。	Sprite3D
		removeChildByName(name:String):Node 根据子节点名字删除对应的子节点对象，如果找不到不会抛出异常。	Node
		removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):Node [override] 删除指定索引区间的所有子对象。	Sprite3D
		removeComponentByType(type:*, typeIndex:int = 0):void 通过指定类型和类型索引移除组件。	Sprite3D
		removeComponentsByType(type:*):void 通过指定类型移除所有组件。	Sprite3D
		removeSelf():Node 从父容器删除自己，如已经被删除不会抛出异常。	Node
		replaceChild(newNode:Node, oldNode:Node):Node 替换子节点。	Node
		setChildIndex(node:Node, index:int):Node 设置子节点的索引位置。	Node
		setLightmapIndex(value:int):void	Terrain
		setLightmapScaleOffset(value:Vector4):void	Terrain
		timerLoop(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true, jumpFrame:Boolean = false):void 定时重复执行某函数。功能同Laya.timer.timerLoop()。	Node
		timerOnce(delay:int, caller:*, method:Function, args:Array = null, coverBefore:Boolean = true):void 定时执行某函数一次。功能同Laya.timer.timerOnce()。	Node
		width():Number 获取地形X轴长度。	Terrain

	Method	Defined By
		_addSelfRenderObjects():void 添加自身渲染物体，请重载此函数。	Sprite3D
		_clearSelfRenderObjects():void 清理自身渲染物体，请重载此函数。	Sprite3D
		_parseCustomProps(rootNode:ComponentNode, innerResouMap:Object, customProps:Object, json:Object):void [override] private	Terrain
		_updateChilds(state:RenderState):void 更新子节点。	Sprite3D
		_updateChildsConch(state:RenderState):void 更新子节点。	Sprite3D

Summary	Defined By
added	添加到父对象后调度。	Node
display	加入节点树时调度。	Node
removed	被父对象移除后调度。	Node
undisplay	从节点树移除时调度。	Node

Property Detail

__VECTOR3__

property

public static var __VECTOR3__:Vector3

LOD_DISTANCE_FACTOR

property

public static var LOD_DISTANCE_FACTOR:Number = 2.0

LOD_TOLERANCE_VALUE

property

public static var LOD_TOLERANCE_VALUE:Number = 4

RENDER_LINE_MODEL

property

public static var RENDER_LINE_MODEL:Boolean = false

terrainRes

property

terrainRes:TerrainRes [write-only]

Implementation
public function set terrainRes(value:TerrainRes):void

Constructor Detail

Terrain

()

Constructor

public function Terrain(terrainRes:TerrainRes = null)

创建一个 MeshSprite3D 实例。

Parameters

terrainRes:TerrainRes (default = null) — 网格,同时会加载网格所用默认材质。

Method Detail

_parseCustomProps

()

method

override protected function _parseCustomProps(rootNode:ComponentNode, innerResouMap:Object, customProps:Object, json:Object):void

private

Parameters

	`rootNode:ComponentNode`

	`innerResouMap:Object`

	`customProps:Object`

	`json:Object`

buildTerrain

()

method

public function buildTerrain(terrainRes:TerrainRes):void

Parameters

terrainRes:TerrainRes

depth

()

method

public function depth():Number

获取地形Z轴长度。

Returns

Number — 地形Z轴长度。

disableLight

()

method

public function disableLight():void

getHeightXZ

()

method

public function getHeightXZ(x:Number, z:Number):Number

获取地形高度。

Parameters

	`x:Number` — X轴坐标。

	`z:Number` — Z轴坐标。

Returns

Number

load

()

method

public static function load(url:String):Terrain

加载网格模板,注意:不缓存。

Parameters

url:String — 模板地址。

Returns

Terrain

setLightmapIndex

()

method

public function setLightmapIndex(value:int):void

Parameters

value:int

setLightmapScaleOffset

()

method

public function setLightmapScaleOffset(value:Vector4):void

Parameters

value:Vector4

width

()

method

public function width():Number

获取地形X轴长度。

Returns

Number — 地形X轴长度。

Fri Sep 29 2017, 06:34 PM +08:00

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Terrain	Properties \| Methods \| Events

Package	laya.d3.terrain
Class	public class Terrain
Inheritance	Terrain Sprite3D ComponentNode Node EventDispatcher Object