Data.WavefrontObj

A (very) minimal microlibrary to load 3D geometry from Wavefront .obj files.

Types

data WavefrontVertex

Contains the data for an individual vertex, with the world-space coordinate, (optional) texture-space coordinate, and the (optional) precalculated normal vector.

TODO: Add an option to add normals for models without them(?).

Constructors

WavefrontVertex

Fields

• _vertexPoint :: !(Point V3 Double)
• _textureCoordinate :: !(Maybe (Point V2 Double))
• _vertexNormal :: !(Maybe (V3 Double))

Instances

Eq WavefrontVertex

Methods

(==) :: WavefrontVertex -> WavefrontVertex -> Bool

(/=) :: WavefrontVertex -> WavefrontVertex -> Bool

Show WavefrontVertex

Methods

showsPrec :: Int -> WavefrontVertex -> ShowS

show :: WavefrontVertex -> String

showList :: [WavefrontVertex] -> ShowS

newtype WavefrontFace' a

The underlying datatype to store the vertices for a face.

Constructors

WavefrontFace [a]

Instances

Functor WavefrontFace'

Methods

fmap :: (a -> b) -> WavefrontFace' a -> WavefrontFace' b

(<$) :: a -> WavefrontFace' b -> WavefrontFace' a

Foldable WavefrontFace'

Methods

fold :: Monoid m => WavefrontFace' m -> m

foldMap :: Monoid m => (a -> m) -> WavefrontFace' a -> m

foldr :: (a -> b -> b) -> b -> WavefrontFace' a -> b

foldr' :: (a -> b -> b) -> b -> WavefrontFace' a -> b

foldl :: (b -> a -> b) -> b -> WavefrontFace' a -> b

foldl' :: (b -> a -> b) -> b -> WavefrontFace' a -> b

foldr1 :: (a -> a -> a) -> WavefrontFace' a -> a

foldl1 :: (a -> a -> a) -> WavefrontFace' a -> a

toList :: WavefrontFace' a -> [a]

null :: WavefrontFace' a -> Bool

length :: WavefrontFace' a -> Int

elem :: Eq a => a -> WavefrontFace' a -> Bool

maximum :: Ord a => WavefrontFace' a -> a

minimum :: Ord a => WavefrontFace' a -> a

sum :: Num a => WavefrontFace' a -> a

product :: Num a => WavefrontFace' a -> a

Eq a => Eq (WavefrontFace' a)

Methods

(==) :: WavefrontFace' a -> WavefrontFace' a -> Bool

(/=) :: WavefrontFace' a -> WavefrontFace' a -> Bool

Show a => Show (WavefrontFace' a)

Methods

showsPrec :: Int -> WavefrontFace' a -> ShowS

show :: WavefrontFace' a -> String

showList :: [WavefrontFace' a] -> ShowS

type WavefrontFace = WavefrontFace' WavefrontVertex

An alias to make the the type signatures look nicer while still allowing the instances that you would want (without pulling in mono-traversable).

newtype WavefrontModel' a

Models are not exactly complicated in this system, just a list of faces.

Constructors

WavefrontModel [a]

Instances

Functor WavefrontModel'

Methods

fmap :: (a -> b) -> WavefrontModel' a -> WavefrontModel' b

(<$) :: a -> WavefrontModel' b -> WavefrontModel' a

Foldable WavefrontModel'

Methods

fold :: Monoid m => WavefrontModel' m -> m

foldMap :: Monoid m => (a -> m) -> WavefrontModel' a -> m

foldr :: (a -> b -> b) -> b -> WavefrontModel' a -> b

foldr' :: (a -> b -> b) -> b -> WavefrontModel' a -> b

foldl :: (b -> a -> b) -> b -> WavefrontModel' a -> b

foldl' :: (b -> a -> b) -> b -> WavefrontModel' a -> b

foldr1 :: (a -> a -> a) -> WavefrontModel' a -> a

foldl1 :: (a -> a -> a) -> WavefrontModel' a -> a

toList :: WavefrontModel' a -> [a]

null :: WavefrontModel' a -> Bool

length :: WavefrontModel' a -> Int

elem :: Eq a => a -> WavefrontModel' a -> Bool

maximum :: Ord a => WavefrontModel' a -> a

minimum :: Ord a => WavefrontModel' a -> a

sum :: Num a => WavefrontModel' a -> a

product :: Num a => WavefrontModel' a -> a

Eq a => Eq (WavefrontModel' a)

Methods

(==) :: WavefrontModel' a -> WavefrontModel' a -> Bool

(/=) :: WavefrontModel' a -> WavefrontModel' a -> Bool

Show a => Show (WavefrontModel' a)

Methods

showsPrec :: Int -> WavefrontModel' a -> ShowS

show :: WavefrontModel' a -> String

showList :: [WavefrontModel' a] -> ShowS

type WavefrontModel = WavefrontModel' WavefrontFace

Another alias to beautify type signatures.

Interface

parseWavefrontObj :: Text -> Either String WavefrontModel

Takes a Text and gives you either an error message or a WavefrontModel containing the geometry data from the input.

loadWavefrontObj :: FilePath -> IO (Either String WavefrontModel)

A convienence function for the common case of loading a model from a text file on disk.