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.

Instances

Eq Location Source
Show Location Source

locX :: Location -> Float Source

locY :: Location -> Float Source

locZ :: Location -> Float Source

locW :: Location -> Float 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.

Instances

Eq TexCoord Source
Show TexCoord Source

texcoordR :: TexCoord -> Float Source

texcoordS :: TexCoord -> Float Source

texcoordT :: TexCoord -> Float 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.

Instances

Eq Normal Source
Show Normal Source

norX :: Normal -> Float Source

norY :: Normal -> Float Source

norZ :: Normal -> Float 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.

Instances

Eq Point Source
Show Point Source

pointLocIndex :: Point -> Int Source

Lines

data Line Source

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

Keep in mind that Line doesn’t represent a polygonal line directly. It represents a line index, which is a pair. In theory, a polygonal line is 2 Lines.

Instances

Eq Line Source
Show Line Source

lineLocIndex :: Line -> Int Source

lineTexCoordIndex :: Line -> Maybe Int Source

Faces

data Face Source

A face is a triplet of indices. Face 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 Face doesn’t have a normal associated with.

Keep in mind that Face doesn’t represent a polygonal face directly. It represents a face index, which is a triplet. In theory, a polygonal face is 3 Faces.

Instances

Eq Face Source
Show Face Source

faceLocIndex :: Face -> Int Source

faceTexCoordIndex :: Face -> Maybe Int Source

faceNorIndex :: Face -> Maybe Int 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.

Instances

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

elObject :: Element a -> Maybe Text Source

elGroups :: Element a -> [Text] Source

elMtl :: Element a -> Maybe Text Source

elValue :: Element a -> 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