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

data Location = Location {
- locX :: !Float
- locY :: !Float
- locZ :: !Float
- locW :: !Float
}
data TexCoord = TexCoord {
- texcoordR :: !Float
- texcoordS :: !Float
- texcoordT :: !Float
}
data Normal = Normal {
- norX :: !Float
- norY :: !Float
- norZ :: !Float
}
data Point = Point {
- pointLocIndex :: !Int
}
data Line = Line {
- lineIndexA :: LineIndex
- lineIndexB :: LineIndex
}
data LineIndex = LineIndex {
- lineLocIndex :: !Int
- lineTexCoordIndex :: !(Maybe Int)
}
data Face = Face FaceIndex FaceIndex FaceIndex [FaceIndex]
data FaceIndex = FaceIndex {
- faceLocIndex :: !Int
- faceTexCoordIndex :: !(Maybe Int)
- faceNorIndex :: !(Maybe Int)
}
pattern Triangle :: FaceIndex -> FaceIndex -> FaceIndex -> Face
pattern Quad :: FaceIndex -> FaceIndex -> FaceIndex -> FaceIndex -> Face
data Element a = Element {
- elObject :: Maybe Text
- elGroups :: [Text]
- elMtl :: Maybe Text
- elSmoothingGroup :: Natural
- elValue :: a
}
data WavefrontOBJ = WavefrontOBJ {
- objLocations :: Vector Location
- objTexCoords :: Vector TexCoord
- objNormals :: Vector Normal
- objPoints :: Vector (Element Point)
- objLines :: Vector (Element Line)
- objFaces :: Vector (Element Face)
- objMtlLibs :: Vector Text
}
module Codec.Wavefront.IO

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

Instances details

Eq Location Source #
Instance details Defined in Codec.Wavefront.Location Methods (==) :: Location -> Location -> Bool # (/=) :: Location -> Location -> Bool #
Show Location Source #
Instance details Defined in Codec.Wavefront.Location Methods showsPrec :: Int -> Location -> ShowS # show :: Location -> String # showList :: [Location] -> ShowS #

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

Instances details

Eq TexCoord Source #
Instance details Defined in Codec.Wavefront.TexCoord Methods (==) :: TexCoord -> TexCoord -> Bool # (/=) :: TexCoord -> TexCoord -> Bool #
Show TexCoord Source #
Instance details Defined in Codec.Wavefront.TexCoord Methods showsPrec :: Int -> TexCoord -> ShowS # show :: TexCoord -> String # showList :: [TexCoord] -> ShowS #

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

Instances details

Eq Normal Source #
Instance details Defined in Codec.Wavefront.Normal Methods (==) :: Normal -> Normal -> Bool # (/=) :: Normal -> Normal -> Bool #
Show Normal Source #
Instance details Defined in Codec.Wavefront.Normal Methods showsPrec :: Int -> Normal -> ShowS # show :: Normal -> String # showList :: [Normal] -> ShowS #

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

Instances details

Eq Point Source #
Instance details Defined in Codec.Wavefront.Point Methods (==) :: Point -> Point -> Bool # (/=) :: Point -> Point -> Bool #
Show Point Source #
Instance details Defined in Codec.Wavefront.Point Methods showsPrec :: Int -> Point -> ShowS # show :: Point -> String # showList :: [Point] -> ShowS #

Lines

data Line Source #

Constructors

Line
Fields lineIndexA :: LineIndex lineIndexB :: LineIndex

Instances

Instances details

Eq Line Source #
Instance details Defined in Codec.Wavefront.Line Methods (==) :: Line -> Line -> Bool # (/=) :: Line -> Line -> Bool #
Show Line Source #
Instance details Defined in Codec.Wavefront.Line Methods showsPrec :: Int -> Line -> ShowS # show :: Line -> String # showList :: [Line] -> ShowS #

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

Instances details

Eq LineIndex Source #
Instance details Defined in Codec.Wavefront.Line Methods (==) :: LineIndex -> LineIndex -> Bool # (/=) :: LineIndex -> LineIndex -> Bool #
Show LineIndex Source #
Instance details Defined in Codec.Wavefront.Line Methods showsPrec :: Int -> LineIndex -> ShowS # show :: LineIndex -> String # showList :: [LineIndex] -> ShowS #

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

Instances details

Eq Face Source #
Instance details Defined in Codec.Wavefront.Face Methods (==) :: Face -> Face -> Bool # (/=) :: Face -> Face -> Bool #
Show Face Source #
Instance details Defined in Codec.Wavefront.Face Methods showsPrec :: Int -> Face -> ShowS # show :: Face -> String # showList :: [Face] -> ShowS #

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

Instances details

Eq FaceIndex Source #
Instance details Defined in Codec.Wavefront.Face Methods (==) :: FaceIndex -> FaceIndex -> Bool # (/=) :: FaceIndex -> FaceIndex -> Bool #
Show FaceIndex Source #
Instance details Defined in Codec.Wavefront.Face Methods showsPrec :: Int -> FaceIndex -> ShowS # show :: FaceIndex -> String # showList :: [FaceIndex] -> ShowS #

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 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

Instances details

Eq a => Eq (Element a) Source #
Instance details Defined in Codec.Wavefront.Element Methods (==) :: Element a -> Element a -> Bool # (/=) :: Element a -> Element a -> Bool #
Show a => Show (Element a) Source #
Instance details Defined in Codec.Wavefront.Element Methods showsPrec :: Int -> Element a -> ShowS # show :: Element a -> String # showList :: [Element a] -> ShowS #

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

Instances details

Eq WavefrontOBJ Source #
Instance details Defined in Codec.Wavefront.Object Methods (==) :: WavefrontOBJ -> WavefrontOBJ -> Bool # (/=) :: WavefrontOBJ -> WavefrontOBJ -> Bool #
Show WavefrontOBJ Source #
Instance details Defined in Codec.Wavefront.Object Methods showsPrec :: Int -> WavefrontOBJ -> ShowS # show :: WavefrontOBJ -> String # showList :: [WavefrontOBJ] -> ShowS #

Re-exports

module Codec.Wavefront.IO