Event
Gameplay
(NOTE) All mouse events that are forwarded to reactive components or the space use this event to add extra data.
Methods | Properties | Base Classes | Derived Classes |
---|---|---|---|
ToWorldPlane | CameraViewport | mouseevent | manipulatortoolevent |
ToWorldViewPlane | HitDistance | ||
ToWorldZPlane | HitNormal | ||
HitObject | |||
HitPosition | |||
HitUv | |||
RayDirection | |||
RayStart | |||
WorldRay |
Properties
CameraViewport : cameraviewport
read-only
Camera viewport that generated this event.
var CameraViewport : CameraViewport
HitDistance : real
The distance away the hit point is. Used with Reactive components.
var HitDistance : Real
HitNormal : real3
The normal at the intersection point with an object. Used with Reactive components.
var HitNormal : Real3
HitObject : cog
read-only
Object hit in ray cast.
var HitObject : Cog
HitPosition : real3
The intersection point with an object. Used with Reactive components.
var HitPosition : Real3
HitUv : real2
The uv texture coordinate at the intersection point, if applicable. Used with Reactive components.
var HitUv : Real2
RayDirection : real3
Mouse Ray Direction.
var RayDirection : Real3
RayStart : real3
Mouse Ray start.
var RayStart : Real3
WorldRay : ray
The world mouse ray.
var WorldRay : Ray
Methods
ToWorldPlane : real3
The world mouse position on any arbitrary plane. |Name|Type|Description| |---|---|---| |worldPlaneNormal|real3| | |worldPlanePosition|real3| |
function ToWorldPlane(worldPlaneNormal : Real3, worldPlanePosition : Real3) : Real3
ToWorldViewPlane : real3
The world mouse position on the view plane at view depth. |Name|Type|Description| |---|---|---| |viewDepth|real| |
function ToWorldViewPlane(viewDepth : Real) : Real3
ToWorldZPlane : real3
The world mouse position on the z plane at depth. |Name|Type|Description| |---|---|---| |worldDepth|real| |
function ToWorldZPlane(worldDepth : Real) : Real3