Safe Haskell	None
Language	GHC2021

Box3D.MathTypes

Contents

Constants

Description

Low-level bindings to the value types in box3d/math_functions.h.

These are the small POD math structs that the Box3D API passes and returns by value. Field order matches the C layout; Storable offsets come straight from the header via hsc2hs. Fields are Float because C float maps to the Haskell FFI Float with an identical representation.

In single-precision builds (the default) b3Pos and b3WorldTransform are typedefs for b3Vec3 and b3Transform, so Pos and WorldTransform are type synonyms here.

Synopsis

Documentation

data Vec2 Source #

A 2D vector.

Constructors

Vec2 Float Float

Instances

Instances details

Storable Vec2 Source #
Instance details Defined in Box3D.MathTypes Methods sizeOf :: Vec2 -> Int # alignment :: Vec2 -> Int # peekElemOff :: Ptr Vec2 -> Int -> IO Vec2 # pokeElemOff :: Ptr Vec2 -> Int -> Vec2 -> IO () # peekByteOff :: Ptr b -> Int -> IO Vec2 # pokeByteOff :: Ptr b -> Int -> Vec2 -> IO () # peek :: Ptr Vec2 -> IO Vec2 # poke :: Ptr Vec2 -> Vec2 -> IO () #
Show Vec2 Source #
Instance details Defined in Box3D.MathTypes Methods showsPrec :: Int -> Vec2 -> ShowS # show :: Vec2 -> String # showList :: [Vec2] -> ShowS #
Eq Vec2 Source #
Instance details Defined in Box3D.MathTypes Methods (==) :: Vec2 -> Vec2 -> Bool # (/=) :: Vec2 -> Vec2 -> Bool #

data Vec3 Source #

A 3D vector.

Constructors

Vec3 Float Float Float

Instances

Instances details

Storable Vec3 Source #
Instance details Defined in Box3D.MathTypes Methods sizeOf :: Vec3 -> Int # alignment :: Vec3 -> Int # peekElemOff :: Ptr Vec3 -> Int -> IO Vec3 # pokeElemOff :: Ptr Vec3 -> Int -> Vec3 -> IO () # peekByteOff :: Ptr b -> Int -> IO Vec3 # pokeByteOff :: Ptr b -> Int -> Vec3 -> IO () # peek :: Ptr Vec3 -> IO Vec3 # poke :: Ptr Vec3 -> Vec3 -> IO () #
Show Vec3 Source #
Instance details Defined in Box3D.MathTypes Methods showsPrec :: Int -> Vec3 -> ShowS # show :: Vec3 -> String # showList :: [Vec3] -> ShowS #
Eq Vec3 Source #
Instance details Defined in Box3D.MathTypes Methods (==) :: Vec3 -> Vec3 -> Bool # (/=) :: Vec3 -> Vec3 -> Bool #

data CosSin Source #

Cosine and sine pair (cosine, sine).

Constructors

CosSin Float Float

Instances

Instances details

Storable CosSin Source #
Instance details Defined in Box3D.MathTypes Methods sizeOf :: CosSin -> Int # alignment :: CosSin -> Int # peekElemOff :: Ptr CosSin -> Int -> IO CosSin # pokeElemOff :: Ptr CosSin -> Int -> CosSin -> IO () # peekByteOff :: Ptr b -> Int -> IO CosSin # pokeByteOff :: Ptr b -> Int -> CosSin -> IO () # peek :: Ptr CosSin -> IO CosSin # poke :: Ptr CosSin -> CosSin -> IO () #
Show CosSin Source #
Instance details Defined in Box3D.MathTypes Methods showsPrec :: Int -> CosSin -> ShowS # show :: CosSin -> String # showList :: [CosSin] -> ShowS #
Eq CosSin Source #
Instance details Defined in Box3D.MathTypes Methods (==) :: CosSin -> CosSin -> Bool # (/=) :: CosSin -> CosSin -> Bool #

data Quat Source #

A quaternion: vector part v and scalar part s.

Constructors

Quat Vec3 Float

Instances

Instances details

Storable Quat Source #
Instance details Defined in Box3D.MathTypes Methods sizeOf :: Quat -> Int # alignment :: Quat -> Int # peekElemOff :: Ptr Quat -> Int -> IO Quat # pokeElemOff :: Ptr Quat -> Int -> Quat -> IO () # peekByteOff :: Ptr b -> Int -> IO Quat # pokeByteOff :: Ptr b -> Int -> Quat -> IO () # peek :: Ptr Quat -> IO Quat # poke :: Ptr Quat -> Quat -> IO () #
Show Quat Source #
Instance details Defined in Box3D.MathTypes Methods showsPrec :: Int -> Quat -> ShowS # show :: Quat -> String # showList :: [Quat] -> ShowS #
Eq Quat Source #
Instance details Defined in Box3D.MathTypes Methods (==) :: Quat -> Quat -> Bool # (/=) :: Quat -> Quat -> Bool #

data Transform Source #

A rigid transform: position p and rotation q.

Constructors

Transform Vec3 Quat

Instances

Instances details

Storable Transform Source #
Instance details Defined in Box3D.MathTypes Methods sizeOf :: Transform -> Int # alignment :: Transform -> Int # peekElemOff :: Ptr Transform -> Int -> IO Transform # pokeElemOff :: Ptr Transform -> Int -> Transform -> IO () # peekByteOff :: Ptr b -> Int -> IO Transform # pokeByteOff :: Ptr b -> Int -> Transform -> IO () # peek :: Ptr Transform -> IO Transform # poke :: Ptr Transform -> Transform -> IO () #
Show Transform Source #
Instance details Defined in Box3D.MathTypes Methods showsPrec :: Int -> Transform -> ShowS # show :: Transform -> String # showList :: [Transform] -> ShowS #
Eq Transform Source #
Instance details Defined in Box3D.MathTypes Methods (==) :: Transform -> Transform -> Bool # (/=) :: Transform -> Transform -> Bool #

data Matrix3 Source #

A 3x3 column-major matrix (columns cx, cy, cz).

Constructors

Matrix3 Vec3 Vec3 Vec3

Instances

Instances details

Storable Matrix3 Source #
Instance details Defined in Box3D.MathTypes Methods sizeOf :: Matrix3 -> Int # alignment :: Matrix3 -> Int # peekElemOff :: Ptr Matrix3 -> Int -> IO Matrix3 # pokeElemOff :: Ptr Matrix3 -> Int -> Matrix3 -> IO () # peekByteOff :: Ptr b -> Int -> IO Matrix3 # pokeByteOff :: Ptr b -> Int -> Matrix3 -> IO () # peek :: Ptr Matrix3 -> IO Matrix3 # poke :: Ptr Matrix3 -> Matrix3 -> IO () #
Show Matrix3 Source #
Instance details Defined in Box3D.MathTypes Methods showsPrec :: Int -> Matrix3 -> ShowS # show :: Matrix3 -> String # showList :: [Matrix3] -> ShowS #
Eq Matrix3 Source #
Instance details Defined in Box3D.MathTypes Methods (==) :: Matrix3 -> Matrix3 -> Bool # (/=) :: Matrix3 -> Matrix3 -> Bool #

data AABB Source #

Axis-aligned bounding box (lowerBound, upperBound).

Constructors

AABB Vec3 Vec3

Instances

Instances details

Storable AABB Source #
Instance details Defined in Box3D.MathTypes Methods sizeOf :: AABB -> Int # alignment :: AABB -> Int # peekElemOff :: Ptr AABB -> Int -> IO AABB # pokeElemOff :: Ptr AABB -> Int -> AABB -> IO () # peekByteOff :: Ptr b -> Int -> IO AABB # pokeByteOff :: Ptr b -> Int -> AABB -> IO () # peek :: Ptr AABB -> IO AABB # poke :: Ptr AABB -> AABB -> IO () #
Show AABB Source #
Instance details Defined in Box3D.MathTypes Methods showsPrec :: Int -> AABB -> ShowS # show :: AABB -> String # showList :: [AABB] -> ShowS #
Eq AABB Source #
Instance details Defined in Box3D.MathTypes Methods (==) :: AABB -> AABB -> Bool # (/=) :: AABB -> AABB -> Bool #

data Plane Source #

A plane: normal and offset where separation = dot(normal, point) - offset.

Constructors

Plane Vec3 Float

Instances

Instances details

Storable Plane Source #
Instance details Defined in Box3D.MathTypes Methods sizeOf :: Plane -> Int # alignment :: Plane -> Int # peekElemOff :: Ptr Plane -> Int -> IO Plane # pokeElemOff :: Ptr Plane -> Int -> Plane -> IO () # peekByteOff :: Ptr b -> Int -> IO Plane # pokeByteOff :: Ptr b -> Int -> Plane -> IO () # peek :: Ptr Plane -> IO Plane # poke :: Ptr Plane -> Plane -> IO () #
Show Plane Source #
Instance details Defined in Box3D.MathTypes Methods showsPrec :: Int -> Plane -> ShowS # show :: Plane -> String # showList :: [Plane] -> ShowS #
Eq Plane Source #
Instance details Defined in Box3D.MathTypes Methods (==) :: Plane -> Plane -> Bool # (/=) :: Plane -> Plane -> Bool #

type Pos = Vec3 Source #

World position. In single-precision builds this is Vec3.

type WorldTransform = Transform Source #

World transform. In single-precision builds this is Transform.

Constants

vec3Zero :: Vec3 Source #

vec3One :: Vec3 Source #

vec3AxisX :: Vec3 Source #

vec3AxisY :: Vec3 Source #

vec3AxisZ :: Vec3 Source #

quatIdentity :: Quat Source #

transformIdentity :: Transform Source #

matrix3Zero :: Matrix3 Source #

matrix3Identity :: Matrix3 Source #