DOL.GS.Point3D Class Reference

Defines a 3D point. More...

Inheritance diagram for DOL.GS.Point3D:

List of all members.

Public Member Functions
	Point3D ()
	Constructs a new 3D point object.
	Point3D (int x, int y, int z)
	Constructs a new 3D point object.
	Point3D (IPoint2D point, int z)
	Constructs a new 3D point object.
	Point3D (IPoint3D point)
	Constructs a new 3D point object.
override void	Clear ()
override string	ToString ()
	Creates the string representation of this point.
virtual int	GetDistanceTo (IPoint3D point)
	Get the distance to a point.
virtual int	GetDistanceTo (IPoint3D point, double zfactor)
	Get the distance to a point (with z-axis adjustment)
bool	IsWithinRadius (IPoint3D point, int radius)
	Determine if another point is within a given radius.
bool	IsWithinRadius (IPoint3D point, int radius, bool ignoreZ)
	Determine if another point is within a given radius, optionally ignoring Z values.
Protected Attributes
int	m_z
	The Z coord of this point.
Properties
virtual int	Z [get, set]
	Z coord of this point.

---

Detailed Description

Defines a 3D point.

---

Constructor & Destructor Documentation

DOL.GS.Point3D.Point3D

(

)

Constructs a new 3D point object.

DOL.GS.Point3D.Point3D	(	int	x,
		int	y,
		int	z
	)

Constructs a new 3D point object.

Parameters:

x	The X coord
y	The Y coord
z	The Z coord

DOL.GS.Point3D.Point3D	(	IPoint2D	point,
		int	z
	)

Constructs a new 3D point object.

Parameters:

point	2D point
z	Z coord

DOL.GS.Point3D.Point3D

(

IPoint3D

point

)

Constructs a new 3D point object.

Parameters:

point

3D point

---

Member Function Documentation

virtual int DOL.GS.Point3D.GetDistanceTo	(	IPoint3D	point,
		double	zfactor
	)		[virtual]

Get the distance to a point (with z-axis adjustment)

Parameters:

point	Target point
zfactor	Z-axis factor - use values between 0 and 1 to decrease influence of Z-axis

Returns:

Adjusted distance to point

Reimplemented in DOL.GS.GameObject.

virtual int DOL.GS.Point3D.GetDistanceTo

(

IPoint3D

point

)

[virtual]

Get the distance to a point.

If you don't actually need the distance value, it is faster to use IsWithinRadius (since it avoids the square root calculation)

Parameters:

point

Target point

Returns:

Distance to point

Reimplemented in DOL.GS.GameObject.

bool DOL.GS.Point3D.IsWithinRadius	(	IPoint3D	point,
		int	radius,
		bool	ignoreZ
	)

Determine if another point is within a given radius, optionally ignoring Z values.

Parameters:

point	Target point
radius	Radius
ignoreZ	ignore Z

Returns:

True if the point is within the radius, otherwise false

bool DOL.GS.Point3D.IsWithinRadius	(	IPoint3D	point,
		int	radius
	)

Determine if another point is within a given radius.

Parameters:

point	Target point
radius	Radius

Returns:

True if the point is within the radius, otherwise false

override string DOL.GS.Point3D.ToString

(

)

Creates the string representation of this point.

Returns:

Reimplemented from DOL.GS.Point2D.

Reimplemented in DOL.GS.GameObject, DOL.GS.GamePlayer, DOL.GS.Keeps.GameKeepComponent, and DOL.GS.MinotaurRelic.

---

Member Data Documentation

int DOL.GS.Point3D.m_z [protected]

The Z coord of this point.

---

Property Documentation

virtual int DOL.GS.Point3D.Z [get, set]

Z coord of this point.

Implements DOL.GS.IPoint3D.

Reimplemented in DOL.GS.GameLiving, DOL.GS.GameNPC, DOL.GS.GamePlayer, and DOL.GS.Housing.House.

---

The documentation for this class was generated from the following file:

• C:/Users/Graveen/Documents/Dawn of Light/Svn DoL/GameServer/world/Point3D.cs