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 Source

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 Source
Show Location Source

Vertex texture coordinates

data TexCoord Source

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 Source
Show TexCoord Source

Vertex normals

data Normal Source

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 Source
Show Normal Source

Points

data Point Source

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 Source
Show Point Source

Lines

data Line Source

Constructors

Line
Fields lineIndexA :: LineIndex lineIndexB :: LineIndex

Instances

Eq Line Source
Show Line Source

data LineIndex Source

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 Source
Show LineIndex Source

Faces

data Face Source

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

Constructors

Face FaceIndex FaceIndex FaceIndex [FaceIndex]

Instances

Eq Face Source
Show Face Source

data FaceIndex Source

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 Source
Show FaceIndex Source

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

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

Element

data Element a Source

An element holds a value along with the user-defined object’s name (if exists), the associated groups and the used material. 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 elValue :: a

Instances

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

Object

data WavefrontOBJ Source

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 Source
Show WavefrontOBJ Source

Re-exports

module Codec.Wavefront.IO