Packageaway3d.core.draw
Classpublic class DrawSegment
InheritanceDrawSegment Inheritance DrawPrimitive

Line segment drawing primitive

Public Properties
 PropertyDefined by
 Inheritedcreate : Function
Placeholder function for creating new drawing primitives from a cache of objects.
DrawPrimitive
 Inheritedgenerated : Boolean
Indicator of whether primitive is the produce of a generator algorithm
DrawPrimitive
  length : Number
The screen length of the segment primitive.
DrawSegment
  material : ISegmentMaterial
The material of the segment primitive.
DrawSegment
 InheritedmaxX : Number
Indicates the maximum x value of the drawing primitive.
DrawPrimitive
 InheritedmaxY : Number
Indicates the maximum y value of the drawing primitive.
DrawPrimitive
 InheritedmaxZ : Number
Indicates the maximum z value of the drawing primitive.
DrawPrimitive
 InheritedminX : Number
Indicates the minimum x value of the drawing primitive.
DrawPrimitive
 InheritedminY : Number
Indicates the minimum y value of the drawing primitive.
DrawPrimitive
 InheritedminZ : Number
Indicates the minimum z value of the drawing primitive.
DrawPrimitive
 Inheritedquadrant : PrimitiveQuadrantTreeNode
Reference to the last quadrant used by the drawing primitive.
DrawPrimitive
 InheritedscreenZ : Number
Indicates the screen z value of the drawing primitive (used for z-sorting).
DrawPrimitive
 Inheritedsource : Object3D
The parent 3d object of the drawing primitive.
DrawPrimitive
  v0 : ScreenVertex
The v0 screenvertex of the segment primitive.
DrawSegment
  v1 : ScreenVertex
The v1 screenvertex of the segment primitive.
DrawSegment
 Inheritedview : View3D
The view 3d object of the drawing primitive.
DrawPrimitive
Public Methods
 MethodDefined by
  
calc():void
Calculates the min, max and screen properties required for rendering the drawing primitive.
DrawSegment
  
clear():void
Deletes the data currently held by the drawing primitive.
DrawSegment
  
contains(x:Number, y:Number):Boolean
Determines whether the given point lies inside the drawing primitive
DrawSegment
  
getZ(x:Number, y:Number):Number
Calulates the screen z value of a precise point on the drawing primitive.
DrawSegment
  
quarter(focus:Number):Array
Cuts the drawing primitive into 4 equally sized drawing primitives.
DrawSegment
  
render():void
Draws the primitive to the view.
DrawSegment
  
toString():String
Used to trace the values of a drawing primitive.
DrawSegment
Property detail
lengthproperty
public var length:Number

The screen length of the segment primitive.

materialproperty 
public var material:ISegmentMaterial

The material of the segment primitive.

v0property 
public var v0:ScreenVertex

The v0 screenvertex of the segment primitive.

v1property 
public var v1:ScreenVertex

The v1 screenvertex of the segment primitive.

Method detail
calc()method
public override function calc():void

Calculates the min, max and screen properties required for rendering the drawing primitive.

clear()method 
public override function clear():void

Deletes the data currently held by the drawing primitive.

contains()method 
public override function contains(x:Number, y:Number):Boolean

Determines whether the given point lies inside the drawing primitive

Parameters
x:Number — The x position of the point to be tested.
 
y:Number — The y position of the point to be tested.

Returns
Boolean — The result of the test.
getZ()method 
public override function getZ(x:Number, y:Number):Number

Calulates the screen z value of a precise point on the drawing primitive.

Parameters
x:Number — The x position of the point to be tested.
 
y:Number — The y position of the point to be tested.

Returns
Number — The screen z value (used in z-sorting).
quarter()method 
public override function quarter(focus:Number):Array

Cuts the drawing primitive into 4 equally sized drawing primitives. Used in z-sorting correction.

Parameters
focus:Number — The focus value of the camera being used in the view.

Returns
Array
render()method 
public override function render():void

Draws the primitive to the view.

toString()method 
public override function toString():String

Used to trace the values of a drawing primitive.

Returns
String — A string representation of the drawing primitive.
Wiki link
Click to go to the wiki page for 'away3d.core.draw.DrawSegment'

Code examples

Comments