away3d.materials.methods.OutlineMethod

	Property	Defined By
		assetFullPath : Array [read-only]	NamedAssetBase
		assetNamespace : String [read-only]	NamedAssetBase
		assetType : String [read-only] The type of the asset.	EffectMethodBase
		id : String	NamedAssetBase
		name : String	NamedAssetBase
		originalName : String [read-only] The original name used for this asset in the resource (e.g.	NamedAssetBase
		outlineColor : uint The colour of the outline.	OutlineMethod
		outlineSize : Number The size of the outline.	OutlineMethod
		passes : Vector.<MaterialPassBase> [read-only] Any passes required that render to a texture used by this method.	ShadingMethodBase
		showInnerLines : Boolean Indicates whether or not strokes should be potentially drawn over the existing model.	OutlineMethod

Property

Defined By

assetFullPath : Array

[read-only]

NamedAssetBase

assetNamespace : String

[read-only]

NamedAssetBase

assetType : String

[read-only] The type of the asset.

EffectMethodBase

id : String

NamedAssetBase

name : String

NamedAssetBase

originalName : String

[read-only] The original name used for this asset in the resource (e.g.

NamedAssetBase

outlineColor : uint

The colour of the outline.

OutlineMethod

outlineSize : Number

The size of the outline.

OutlineMethod

passes : Vector.<MaterialPassBase>

[read-only] Any passes required that render to a texture used by this method.

ShadingMethodBase

showInnerLines : Boolean

Indicates whether or not strokes should be potentially drawn over the existing model.

OutlineMethod

	Property	Defined By
		_passes : Vector.<MaterialPassBase>	ShadingMethodBase
		_sharedRegisters : ShaderRegisterData	ShadingMethodBase

Property

Defined By

_passes : Vector.<MaterialPassBase>

ShadingMethodBase

_sharedRegisters : ShaderRegisterData

ShadingMethodBase

	Method	Defined By
		OutlineMethod(outlineColor:uint = 0x000000, outlineSize:Number = 1, showInnerLines:Boolean = true, dedicatedWaterProofMesh:Boolean = false) Creates a new OutlineMethod object.	OutlineMethod
		assetPathEquals(name:String, ns:String):Boolean	NamedAssetBase
		copyFrom(method:ShadingMethodBase):void Copies the state from a ShadingMethodBase object into the current object.	ShadingMethodBase
		dispose():void Cleans up any resources used by the current object.	ShadingMethodBase
		resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void	NamedAssetBase

Method

Defined By

OutlineMethod(outlineColor:uint = 0x000000, outlineSize:Number = 1, showInnerLines:Boolean = true, dedicatedWaterProofMesh:Boolean = false)

Creates a new OutlineMethod object.

OutlineMethod

assetPathEquals(name:String, ns:String):Boolean

NamedAssetBase

copyFrom(method:ShadingMethodBase):void

Copies the state from a ShadingMethodBase object into the current object.

ShadingMethodBase

dispose():void

Cleans up any resources used by the current object.

ShadingMethodBase

resetAssetPath(name:String, ns:String = null, overrideOriginal:Boolean = true):void

NamedAssetBase

	Method	Defined By
		getTex2DSampleCode(vo:MethodVO, targetReg:ShaderRegisterElement, inputReg:ShaderRegisterElement, texture:TextureProxyBase, uvReg:ShaderRegisterElement = null, forceWrap:String = null):String A helper method that generates standard code for sampling from a texture using the normal uv coordinates.	ShadingMethodBase
		getTexCubeSampleCode(vo:MethodVO, targetReg:ShaderRegisterElement, inputReg:ShaderRegisterElement, texture:TextureProxyBase, uvReg:ShaderRegisterElement):String A helper method that generates standard code for sampling from a cube texture.	ShadingMethodBase
		invalidateShaderProgram():void Marks the shader program as invalid, so it will be recompiled before the next render.	ShadingMethodBase

Method

Defined By

getTex2DSampleCode(vo:MethodVO, targetReg:ShaderRegisterElement, inputReg:ShaderRegisterElement, texture:TextureProxyBase, uvReg:ShaderRegisterElement = null, forceWrap:String = null):String

A helper method that generates standard code for sampling from a texture using the normal uv coordinates.

ShadingMethodBase

getTexCubeSampleCode(vo:MethodVO, targetReg:ShaderRegisterElement, inputReg:ShaderRegisterElement, texture:TextureProxyBase, uvReg:ShaderRegisterElement):String

A helper method that generates standard code for sampling from a cube texture.

ShadingMethodBase

invalidateShaderProgram():void

Marks the shader program as invalid, so it will be recompiled before the next render.

ShadingMethodBase

	Constant	Defined By
		DEFAULT_NAMESPACE : String = default [static]	NamedAssetBase

Constant

Defined By

DEFAULT_NAMESPACE : String = default

[static]

NamedAssetBase

Property Detail

outlineColor

property

outlineColor:uint

The colour of the outline.

Implementation
public function get outlineColor():uint
public function set outlineColor(value:uint):void

outlineSize

property

outlineSize:Number

The size of the outline.

Implementation
public function get outlineSize():Number
public function set outlineSize(value:Number):void

showInnerLines

property

showInnerLines:Boolean

Indicates whether or not strokes should be potentially drawn over the existing model. Set this to true to draw outlines for geometry overlapping in the view, useful to achieve a cel-shaded drawing outline. Setting this to false will only cause the outline to appear around the 2D projection of the geometry.

Implementation
public function get showInnerLines():Boolean
public function set showInnerLines(value:Boolean):void

Constructor Detail

OutlineMethod

()

Constructor

public function OutlineMethod(outlineColor:uint = 0x000000, outlineSize:Number = 1, showInnerLines:Boolean = true, dedicatedWaterProofMesh:Boolean = false)

Creates a new OutlineMethod object.

Parameters

	`outlineColor:uint` (default = `0x000000`) — The colour of the outline stroke

	`outlineSize:Number` (default = `1`) — The size of the outline stroke

	`showInnerLines:Boolean` (default = `true`) — Indicates whether or not strokes should be potentially drawn over the existing model.

	`dedicatedWaterProofMesh:Boolean` (default = `false`) — Used to stitch holes appearing due to mismatching normals for overlapping vertices. Warning: this will create a new mesh that is incompatible with animations!

Method Detail

activate

()

method

override arcane function activate(vo:MethodVO, stage3DProxy:Stage3DProxy):void

Parameters

	`vo:MethodVO`

	`stage3DProxy:Stage3DProxy`

getFragmentCode

()

method

override arcane function getFragmentCode(vo:MethodVO, regCache:ShaderRegisterCache, targetReg:ShaderRegisterElement):String

Parameters

	`vo:MethodVO`

	`regCache:ShaderRegisterCache`

	`targetReg:ShaderRegisterElement`

Returns

String

initVO

()

method

override arcane function initVO(vo:MethodVO):void

Initializes the properties for a MethodVO, including register and texture indices.

Parameters

vo:MethodVO — The MethodVO object linking this method with the pass currently being compiled.

reset

()

method

override arcane function reset():void

Resets the compilation state of the method.

Thu Jul 11 2013, 08:55 PM +01:00

Away3D 4.1 Documentation	All Packages \| All Classes \| Index \| Frames No Frames
OutlineMethod	Properties \| Methods \| Constants

Package	away3d.materials.methods
Class	public class OutlineMethod
Inheritance	OutlineMethod EffectMethodBase ShadingMethodBase NamedAssetBase flash.events.EventDispatcher