Copyright	(C) 2015 Dimitri Sabadie
License	BSD3
Maintainer	Dimitri Sabadie <dimitri.sabadie@gmail.com>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Codec.Wavefront

Contents

Vertex location
Vertex texture coordinates
Vertex normals
Points
Lines
Faces
Element
Object
Re-exports

Description

Currently, you can parse a file and get a WavefrontOBJ with the fromFile function.

Synopsis

Vertex location

data Location

A location is a 4-floating vector. You can access to its components by pattern matching on them:

  let Location x y z w = Location 1 2 3 4

That type is strict and unboxed.

Constructors

Location
Fields locX :: !Float locY :: !Float locZ :: !Float locW :: !Float

Instances

Eq Location
Show Location

Vertex texture coordinates

data TexCoord

A texture coordinate is a 3D-floating vector. You can access to its components by pattern matching on them:

  let TexCoord r s t = TexCoord 0.1 0.2 0.3

That type is strcit and unboxed.

Constructors

TexCoord
Fields texcoordR :: !Float texcoordS :: !Float texcoordT :: !Float

Instances

Eq TexCoord
Show TexCoord

Vertex normals

data Normal

A normal is a 3-floating vector. You can access to its components by pattern matching on them:

  let Normal nx ny nz = Normal 0.1 0.2 0.3

That type is strict and unboxed.

Constructors

Normal
Fields norX :: !Float norY :: !Float norZ :: !Float

Instances

Eq Normal
Show Normal

Points

data Point

A point is a single index that references the locations. It’s a canonical type that truly represents a polygonal point.

Constructors

Point
Fields pointLocIndex :: !Int

Instances

Eq Point
Show Point

Lines

data Line

Constructors

Line
Fields lineIndexA :: LineIndex lineIndexB :: LineIndex

Instances

Eq Line
Show Line

data LineIndex

A line index is a pair of indices. LineIndex vi vti. vi references the locations and vti indexes the texture coordinates. If vti == Nothing, then that LineIndex doesn’t have texture coordinates associated with.

Constructors

LineIndex
Fields lineLocIndex :: !Int lineTexCoordIndex :: !(Maybe Int)

Instances

Eq LineIndex
Show LineIndex

Faces

data Face

A face gathers several FaceIndex to build up faces. It has a least three vertices

Constructors

Face FaceIndex FaceIndex FaceIndex [FaceIndex]

Instances

Eq Face
Show Face

data FaceIndex

A face index is a triplet of indices. FaceIndex vi vti vni is a face that indexes the locations with vi, the texture coordinates with vti and the normals with vni. An index set to Nothing means no information. That is, if vni == Nothing, then that FaceIndex doesn’t have a normal associated with.

Constructors

FaceIndex
Fields faceLocIndex :: !Int faceTexCoordIndex :: !(Maybe Int) faceNorIndex :: !(Maybe Int)

Instances

Eq FaceIndex
Show FaceIndex

pattern Triangle :: FaceIndex -> FaceIndex -> FaceIndex -> Face

pattern Quad :: FaceIndex -> FaceIndex -> FaceIndex -> FaceIndex -> Face

Element

data Element a

An element holds a value along with the user-defined object’s name (if any), the associated groups, the used material and the smoothing group the element belongs to (if any). Those values can be used to sort the data per object or per group and to lookup materials.

Constructors

Element
Fields elObject :: Maybe Text elGroups :: [Text] elMtl :: Maybe Text elSmoothingGroup :: Natural elValue :: a

Instances

Eq a => Eq (Element a)
Show a => Show (Element a)

Object

data WavefrontOBJ

Constructors

WavefrontOBJ
Fields objLocations :: Vector Location Locations. objTexCoords :: Vector TexCoord Texture coordinates. objNormals :: Vector Normal Normals. objPoints :: Vector (Element Point) Points. objLines :: Vector (Element Line) Lines. objFaces :: Vector (Element Face) Faces. objMtlLibs :: Vector Text Material libraries.

Instances

Eq WavefrontOBJ
Show WavefrontOBJ

Re-exports

module Codec.Wavefront.IO