Main Page Packages Class Tree Index Help

Previous | Next

Summary: Field | Property | Contructor | Method

Detail: Field | Property | Contructor | Method

de.mirell.m3d

class CVertex

Object | +--de.mirell.m3d.CVertex

Implemented Interfaces: IPositionable, IScaleable, IXMLSerializableAll Known Subclasses: CControlVertex

class CVertex extends Object

Standard Vertex representation.

The CVertex class provides methods to work with vertices. It holds the Vertex's position in Object, World, View and Screenspace.

Author:
Mirell Development
Version:
1.0.0

Field Summary

public onRotated: Function

Constructor

public CVertex ( Pos: CCoordinate)

Create a new CVertex using the supplied position as a base

Method Summary

public fromXML ( value: XML ): Void

Unserializes XML into the object

public getObjectSpaceCoordinates ( ): CCoordinate

public getPosition ( ): CCoordinate

Retrieves the current center point of the object

public getScreenCoordinates ( ): CCoordinate

public getViewSpaceCoordinates ( ): CCoordinate

public getWorldSpaceCoordinates ( ): CCoordinate

public isChanged ( ): Boolean

public rotate ( Value: CQuaternion ): Void

public scale ( Value: CCoordinate ): Void

Scale the object in space

public setObjectSpaceCoordinates ( Value: CCoordinate ): Void

public setPosition ( Value: CCoordinate ): Void

Sets initial position of the vertex

public setScreenCoordinates ( Value: CCoordinate ): Void

public setViewSpaceCoordinates ( Value: CCoordinate ): Void

public setWorldSpaceCoordinates ( Value: CCoordinate ): Void

public toString ( ): String

Converts the specified object to a string and returns it.

public toXML ( ): XML

Serializes the object into XML

public translate ( Value: CCoordinate ): Void

Translate the position of the object

Field Documentation

onRotated

public var onRotated: Function

Constructor Documentation

CVertex

public function CVertex (

Pos: CCoordinate)

Create a new CVertex using the supplied position as a base

Parameters:
Pos
Initial position of the Vertex.

Method Documentation

fromXML

public function fromXML (

value: XML): Void

Unserializes XML into the object

Object state is set according to XML.

Specified by:
fromXML in interface de.mirell.xml.serialization.IXMLSerializable
Parameters:
value
XML which represents the serialized form of the object

getObjectSpaceCoordinates

public function getObjectSpaceCoordinates (

): CCoordinate

getPosition

public function getPosition (

): CCoordinate

Retrieves the current center point of the object

Specified by:
getPosition in interface IPositionable
Returns:
The center of the object

getScreenCoordinates

public function getScreenCoordinates (

): CCoordinate

getViewSpaceCoordinates

public function getViewSpaceCoordinates (

): CCoordinate

getWorldSpaceCoordinates

public function getWorldSpaceCoordinates (

): CCoordinate

isChanged

public function isChanged (

): Boolean

rotate

public function rotate (

Value: CQuaternion): Void

scale

public function scale (

Value: CCoordinate): Void

Scale the object in space

Specified by:
scale in interface IScaleable
Parameters:
Value
The amount to scale the object's x,y and z values using a CCoordinate

setObjectSpaceCoordinates

public function setObjectSpaceCoordinates (

Value: CCoordinate): Void

setPosition

public function setPosition (

Value: CCoordinate): Void

Sets initial position of the vertex

Specified by:
setPosition in interface IPositionable
Parameters:
Value
The new position. This also affects the ObjectSpaceCoordinates.

setScreenCoordinates

public function setScreenCoordinates (

Value: CCoordinate): Void

setViewSpaceCoordinates

public function setViewSpaceCoordinates (

Value: CCoordinate): Void

setWorldSpaceCoordinates

public function setWorldSpaceCoordinates (

Value: CCoordinate): Void

toString

public function toString (

): String

Converts the specified object to a string and returns it.

Overrides:
Object.toString in class Object
Returns:
A string.

toXML

public function toXML (

): XML

Serializes the object into XML

The current object state will be serialized. The fromXML method must be able to unserialize the XML.

Specified by:
toXML in interface de.mirell.xml.serialization.IXMLSerializable
Returns:
The XML which contains the serialized representation of the object

translate

public function translate (

Value: CCoordinate): Void

Translate the position of the object

Specified by:
translate in interface ITranslateable
Parameters:
Value
The amount to translate the object's position's x,y and z values using a CCoordinate

The documentation was generated from the following file:

CVertex.as, Last Modified: 03.09.2004 03:41:40