cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages

Class AutoTraceRayLocalImpl

java.lang.Object

cz.cuni.amis.pogamut.base.communication.messages.InfoMessage

cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.AutoTraceRayLocal

cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.AutoTraceRayLocalImpl

All Implemented Interfaces:

IWorldObject, ILocalWorldObject, Cloneable

public class AutoTraceRayLocalImpl
extends AutoTraceRayLocal

Implementation of the local part of the GameBots2004 message ATR.

Complete message documentation: Synchronous message. Contains the results of automatically casted rays. One ATR message is for one casted ray. New automatically casted rays can be defined by ADDRAY command and removed by REMOVERAY command.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutoTraceRayLocalImpl.AutoTraceRayLocalUpdate

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	FastTrace True if it is a fast trace, false if not (fast trace is a bit faster version of UT2004 ray trace - but provides us with less information - just true/false if we hit something on the way or not).
protected boolean	FloorCorrection If we should correct ray directions accoring floor normal.
protected Location	From Location from which the ray is emitted.
protected UnrealId	HitId Id of the actor we have hit.
protected Location	HitLocation Vector with location of the collision (not sent if FastTrace is True).
protected javax.vecmath.Vector3d	HitNormal Vector with normal of the plane we have hit (not sent if FastTrace is True).
protected UnrealId	Id An Id for this ray (should be unique), assigned by the user when adding ray.
protected boolean	Result True if it hit something, false if not.
protected Location	To Location to which the ray is sent.
protected boolean	TraceActors If we traced also actors with this ray (actors – moving things in a game – bots, players, monsters, pickup …) (only if NOT using FastTrace)

Fields inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.AutoTraceRayLocal

SimTime

Constructor Summary

Constructors

Constructor and Description
AutoTraceRayLocalImpl() Parameter-less contructor for the message.
AutoTraceRayLocalImpl(AutoTraceRay original) Cloning constructor from the full message.
AutoTraceRayLocalImpl(AutoTraceRayLocal original) Cloning constructor from the message part.
AutoTraceRayLocalImpl(AutoTraceRayLocalImpl original) Cloning constructor from the full message.
AutoTraceRayLocalImpl(UnrealId Id, Location From, Location To, boolean FastTrace, boolean FloorCorrection, boolean Result, javax.vecmath.Vector3d HitNormal, Location HitLocation, boolean TraceActors, UnrealId HitId) Creates new instance of the message AutoTraceRay.

Method Summary

Methods

Modifier and Type	Method and Description
AutoTraceRayLocalImpl	clone()
Location	getFrom() Location from which the ray is emitted.
UnrealId	getHitId() Id of the actor we have hit.
Location	getHitLocation() Vector with location of the collision (not sent if FastTrace is True).
javax.vecmath.Vector3d	getHitNormal() Vector with normal of the plane we have hit (not sent if FastTrace is True).
UnrealId	getId() An Id for this ray (should be unique), assigned by the user when adding ray.
AutoTraceRayLocalImpl	getLocal()
ISharedWorldObject	getShared()
IStaticWorldObject	getStatic()
Location	getTo() Location to which the ray is sent.
boolean	isFastTrace() True if it is a fast trace, false if not (fast trace is a bit faster version of UT2004 ray trace - but provides us with less information - just true/false if we hit something on the way or not).
boolean	isFloorCorrection() If we should correct ray directions accoring floor normal.
boolean	isResult() True if it hit something, false if not.
boolean	isTraceActors() If we traced also actors with this ray (actors – moving things in a game – bots, players, monsters, pickup …) (only if NOT using FastTrace)
void	setSimTime(long SimTime) Used by Yylex to slip correct time of the object or programmatically.
String	toHtmlString()
String	toString()

Methods inherited from class cz.cuni.amis.pogamut.ut2004.communication.messages.gbinfomessages.AutoTraceRayLocal

getCompositeClass, getSimTime

Methods inherited from class cz.cuni.amis.pogamut.base.communication.messages.InfoMessage

toJsonLiteral

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

Id

protected UnrealId Id

An Id for this ray (should be unique), assigned by the user when adding ray.

From

protected Location From

Location from which the ray is emitted.

To

protected Location To

Location to which the ray is sent.

FastTrace

protected boolean FastTrace

True if it is a fast trace, false if not (fast trace is a bit faster version of UT2004 ray trace - but provides us with less information - just true/false if we hit something on the way or not).

FloorCorrection

protected boolean FloorCorrection

If we should correct ray directions accoring floor normal. Note: Has issue - we can't set set rays up or down when correction is active.

Result

protected boolean Result

True if it hit something, false if not.

HitNormal

protected javax.vecmath.Vector3d HitNormal

Vector with normal of the plane we have hit (not sent if FastTrace is True).

HitLocation

protected Location HitLocation

Vector with location of the collision (not sent if FastTrace is True).

TraceActors

protected boolean TraceActors

If we traced also actors with this ray (actors – moving things in a game – bots, players, monsters, pickup …) (only if NOT using FastTrace)

HitId

protected UnrealId HitId

Id of the actor we have hit. (Sent if FastTrace is False and TraceActors is True).

Constructor Detail

AutoTraceRayLocalImpl

public AutoTraceRayLocalImpl()

Parameter-less contructor for the message.

AutoTraceRayLocalImpl

public AutoTraceRayLocalImpl(UnrealId Id,
                     Location From,
                     Location To,
                     boolean FastTrace,
                     boolean FloorCorrection,
                     boolean Result,
                     javax.vecmath.Vector3d HitNormal,
                     Location HitLocation,
                     boolean TraceActors,
                     UnrealId HitId)

Creates new instance of the message AutoTraceRay. Synchronous message. Contains the results of automatically casted rays. One ATR message is for one casted ray. New automatically casted rays can be defined by ADDRAY command and removed by REMOVERAY command. Corresponding GameBots message (local part) is ATR.

Parameters:

Id - An Id for this ray (should be unique), assigned by the user when adding ray.

From - Location from which the ray is emitted.

To - Location to which the ray is sent.

FastTrace - True if it is a fast trace, false if not (fast trace is a bit faster version of UT2004 ray trace - but provides us with less information - just true/false if we hit something on the way or not).

FloorCorrection - If we should correct ray directions accoring floor normal. Note: Has issue - we can't set set rays up or down when correction is active.

Result - True if it hit something, false if not.

HitNormal - Vector with normal of the plane we have hit (not sent if FastTrace is True).

HitLocation - Vector with location of the collision (not sent if FastTrace is True).

TraceActors - If we traced also actors with this ray (actors – moving things in a game – bots, players, monsters, pickup …) (only if NOT using FastTrace)

HitId - Id of the actor we have hit. (Sent if FastTrace is False and TraceActors is True).

AutoTraceRayLocalImpl

public AutoTraceRayLocalImpl(AutoTraceRay original)

Cloning constructor from the full message.

Parameters:

original -

AutoTraceRayLocalImpl

public AutoTraceRayLocalImpl(AutoTraceRayLocalImpl original)

Cloning constructor from the full message.

Parameters:

original -

AutoTraceRayLocalImpl

public AutoTraceRayLocalImpl(AutoTraceRayLocal original)

Cloning constructor from the message part.

Parameters:

original -

Method Detail

setSimTime

public void setSimTime(long SimTime)

Description copied from class: AutoTraceRayLocal

Used by Yylex to slip correct time of the object or programmatically.

Overrides:

setSimTime in class AutoTraceRayLocal

clone

public AutoTraceRayLocalImpl clone()

Specified by:

clone in interface ILocalWorldObject

Specified by:

clone in class AutoTraceRayLocal

getId

public UnrealId getId()

An Id for this ray (should be unique), assigned by the user when adding ray.

Specified by:

getId in interface IWorldObject

Specified by:

getId in class AutoTraceRayLocal

getFrom

public Location getFrom()

Location from which the ray is emitted.

Specified by:

getFrom in class AutoTraceRayLocal

getTo

public Location getTo()

Location to which the ray is sent.

Specified by:

getTo in class AutoTraceRayLocal

isFastTrace

public boolean isFastTrace()

True if it is a fast trace, false if not (fast trace is a bit faster version of UT2004 ray trace - but provides us with less information - just true/false if we hit something on the way or not).

Specified by:

isFastTrace in class AutoTraceRayLocal

isFloorCorrection

public boolean isFloorCorrection()

If we should correct ray directions accoring floor normal. Note: Has issue - we can't set set rays up or down when correction is active.

Specified by:

isFloorCorrection in class AutoTraceRayLocal

isResult

public boolean isResult()

True if it hit something, false if not.

Specified by:

isResult in class AutoTraceRayLocal

getHitNormal

public javax.vecmath.Vector3d getHitNormal()

Vector with normal of the plane we have hit (not sent if FastTrace is True).

Specified by:

getHitNormal in class AutoTraceRayLocal

getHitLocation

public Location getHitLocation()

Vector with location of the collision (not sent if FastTrace is True).

Specified by:

getHitLocation in class AutoTraceRayLocal

isTraceActors

public boolean isTraceActors()

If we traced also actors with this ray (actors – moving things in a game – bots, players, monsters, pickup …) (only if NOT using FastTrace)

Specified by:

isTraceActors in class AutoTraceRayLocal

getHitId

public UnrealId getHitId()

Id of the actor we have hit. (Sent if FastTrace is False and TraceActors is True).

Specified by:

getHitId in class AutoTraceRayLocal

getLocal

public AutoTraceRayLocalImpl getLocal()

Overrides:

getLocal in class AutoTraceRayLocal

getShared

public ISharedWorldObject getShared()

Overrides:

getShared in class AutoTraceRayLocal

getStatic

public IStaticWorldObject getStatic()

Overrides:

getStatic in class AutoTraceRayLocal

toString

public String toString()

Overrides:

toString in class AutoTraceRayLocal

toHtmlString

public String toHtmlString()

Overrides:

toHtmlString in class AutoTraceRayLocal