diff --git a/Graphics/Animation/Cal3D.hs b/Graphics/Animation/Cal3D.hs new file mode 100644 --- /dev/null +++ b/Graphics/Animation/Cal3D.hs @@ -0,0 +1,25 @@ +{-# LANGUAGE ForeignFunctionInterface #-} +{-# INCLUDE "cal3d_c.h" #-} + +module Graphics.Animation.Cal3D + ( + module Graphics.Animation.Cal3D.Types + , module Graphics.Animation.Cal3D.CoreModel + , module Graphics.Animation.Cal3D.Model + , module Graphics.Animation.Cal3D.Mixer + , module Graphics.Animation.Cal3D.Renderer + , module Graphics.Animation.Cal3D.Error -- is this needed? + ) + +where + +import Foreign +import Foreign.C.Types +import Foreign.C.String + +import Graphics.Animation.Cal3D.Types +import Graphics.Animation.Cal3D.CoreModel +import Graphics.Animation.Cal3D.Model +import Graphics.Animation.Cal3D.Mixer +import Graphics.Animation.Cal3D.Renderer +import Graphics.Animation.Cal3D.Error diff --git a/Graphics/Animation/Cal3D/CoreModel.hs b/Graphics/Animation/Cal3D/CoreModel.hs new file mode 100644 --- /dev/null +++ b/Graphics/Animation/Cal3D/CoreModel.hs @@ -0,0 +1,139 @@ +{-# LANGUAGE ForeignFunctionInterface #-} +{-# INCLUDE "cal3d_c.h" #-} + +{- | A 'CoreModel' is a model type from which many instance 'Model's can be +created. For example, there could be a clown CoreModel and many +individual clown instances. The CoreModel contains data shared +by its instances: + +* A single skeleton + +* One or more meshes, represented by 'MeshId's + +* One or more animations, represented by 'AnimationId's + +* One or more materials, represented by 'MaterialId's + +Each of these may be loaded from a file by the +appropriate loader function, for example, 'loadCoreSkeleton'. + +Materials of the CoreModel are organized by "sets" and "threads." +Within a material set, represented by a 'MaterialSetId', all materials +have the same appearance, such as metal or wood. +Each material thread, represented by a 'MaterialThreadId', +is associated with a particular part of the model, such as head or arm. +Changing material sets of a model (instance) is a convenient way +of changing the character's costume or over-all look. +-} + +module Graphics.Animation.Cal3D.CoreModel + (newCoreModel, deleteCoreModel + , loadCoreSkeleton + , loadCoreAnimation + , loadCoreMesh + , loadCoreMaterial + , createCoreMaterialThread + , setCoreMaterialId + ) + +where + +import Foreign +import Foreign.C.Types +import Foreign.C.String + +import Graphics.Animation.Cal3D.Types +import Graphics.Animation.Cal3D.Error + +-- | Create a CoreModel +newCoreModel :: String -- ^ name + -> IO CoreModel +newCoreModel name = withCString name c_newCoreModel + +foreign import ccall safe "newCoreModel" + c_newCoreModel :: CString -> IO CoreModel + +-- | Destroy a CoreModel +foreign import ccall safe "deleteCoreModel" + deleteCoreModel :: CoreModel -> IO () + +-- | Load a core skeleton from a file. +loadCoreSkeleton :: CoreModel -> FilePath -> LoadResult () +loadCoreSkeleton coreModel path = + -- This is like loader, below, except that "bad" values are 0 + -- instead of -1, and there's no wrapper (?) + checkError (withCString path (c_loadCoreSkeleton coreModel)) + 0 + ("loadCoreSkeleton: unable to load " ++ path) + +foreign import ccall safe "loadCoreSkeleton" c_loadCoreSkeleton :: CLoader + +-- loader c_load fname wrapper: +-- given a C function such as c_loadCoreMaterial, +-- a String to name the load function, and +-- a wrapper function for the result such as MaterialId, +-- or id if you don't care to wrap, +-- returns a loader: that is, a function that takes a file path +-- and returns a (LoadResult a). + +loader :: CLoader -> String -> (CInt -> a) -> Loader a +loader c_load loaderName wrap = + (\ coreModel path -> do + { + id <- withCString path (c_load coreModel) + ; return (if id == (-1) + then Left $ loaderName ++ ": unable to load " ++ path + else Right (wrap id)) + } + ) + + +-- | Load a core animation from a file +loadCoreAnimation :: Loader AnimationId +loadCoreAnimation = loader c_loadCoreAnimation "loadCoreAnimation" AnimationId + +foreign import ccall safe "loadCoreAnimation" c_loadCoreAnimation :: CLoader + +-- | Load a core mesh from a file +loadCoreMesh :: Loader MeshId +loadCoreMesh = loader c_loadCoreMesh "loadCoreMesh" MeshId + +foreign import ccall safe "loadCoreMesh" c_loadCoreMesh :: CLoader + +-- | Load a core material from a file +loadCoreMaterial :: Loader MaterialId +loadCoreMaterial = loader c_loadCoreMaterial "loadCoreMaterial" MaterialId + +foreign import ccall safe "loadCoreMaterial" c_loadCoreMaterial :: CLoader + +-- | Create a core material thread. + +createCoreMaterialThread :: CoreModel -> MaterialThreadId -> + IO (Either String ()) +createCoreMaterialThread coreModel (MaterialThreadId id) = + checkError (c_createCoreMaterialThread coreModel (fromIntegral id)) + 0 + ("createCoreMaterialThread failed with id " ++ (show id)) + +foreign import ccall safe "createCoreMaterialThread" + c_createCoreMaterialThread :: CoreModel -> CInt -> IO CInt + +-- | Apply the material identified by a material thread and material set. +setCoreMaterialId :: CoreModel -> MaterialThreadId -> MaterialSetId -> + MaterialId -> IO (Either String ()) + +setCoreMaterialId coreModel + (MaterialThreadId mthreadId) + (MaterialSetId msetId) + (MaterialId matlId) = + checkError (c_setCoreMaterialId coreModel + (fromIntegral mthreadId) + (fromIntegral msetId) + (fromIntegral matlId)) + 0 + ("setCoreMaterialId failed with ids " ++ + (show (mthreadId, msetId, matlId))) + +foreign import ccall safe "setCoreMaterialId" + c_setCoreMaterialId :: CoreModel -> CInt -> CInt -> CInt -> IO CInt + diff --git a/Graphics/Animation/Cal3D/Error.hs b/Graphics/Animation/Cal3D/Error.hs new file mode 100644 --- /dev/null +++ b/Graphics/Animation/Cal3D/Error.hs @@ -0,0 +1,43 @@ +-- Does this need to be exported from Cal3D? + +module Graphics.Animation.Cal3D.Error + (Fallible, IOFallible + , checkErrorValue, checkError + ) + +where + +type Fallible a = Either String a -- ??? +type IOFallible a = IO (Fallible a) -- ??? + +-- | Compares the result of an action with a bad value, such as an +-- error code, returns (Left errormessage) if action value == bad, +-- otherwise (Right actionresult) +checkErrorValue :: (Eq a) => + IO a -- ^ action + -> a -- ^ bad value + -> String -- ^ error message + -> IO (Either String a) +checkErrorValue action bad errmsg = do + { + result <- action + ; return (if result == bad + then Left errmsg + else Right result) + } + +-- | Like checkError, but returns (Right ()) instead of an interesting value. +checkError :: (Eq a) => + IO a -- ^ action + -> a -- ^ bad value + -> String -- ^ error message + -> IO (Either String ()) +checkError action bad errmsg = do + { + eresult <- checkErrorValue action bad errmsg + ; return (case eresult of + Left errmsg -> Left errmsg + Right _ -> Right ()) + } + + diff --git a/Graphics/Animation/Cal3D/Mixer.hs b/Graphics/Animation/Cal3D/Mixer.hs new file mode 100644 --- /dev/null +++ b/Graphics/Animation/Cal3D/Mixer.hs @@ -0,0 +1,74 @@ +{-# LANGUAGE ForeignFunctionInterface #-} +{-# INCLUDE "cal3d_c.h" #-} + +module Graphics.Animation.Cal3D.Mixer + (newMixer, deleteMixer + , blendCycle, clearCycle, executeAction + ) + +where + +import Foreign +import Foreign.C.Types +import Foreign.C.String + +import Graphics.Animation.Cal3D.Types +import Graphics.Animation.Cal3D.Error + +-- | Create a Mixer. +foreign import ccall safe "newMixer" + newMixer :: IO Mixer + +-- | Destroy a Mixer. +foreign import ccall safe "deleteMixer" + deleteMixer :: Mixer -> IO () + +-- | Add an animation to be "cycled" (repeated) to the current mix. +-- The animation will continue playing until removed by 'clearCycle'. + +blendCycle :: Mixer + -> AnimationId + -> Float -- ^ weight of this animation; weights should sum to 1.0 + -> Float -- ^ delay in seconds before the animation starts + -> IO (Either String ()) +blendCycle mixer (AnimationId id) weight delay = + checkError (c_blendCycle mixer id + (realToFrac weight) + (realToFrac delay)) + 0 "blendCycle failed" + +foreign import ccall safe "blendCycle" + c_blendCycle :: Mixer -> CInt -> CFloat -> CFloat -> IO CInt + +-- | Remove a "cycled" animation from the current mix. + +clearCycle :: Mixer + -> AnimationId + -> Float -- ^ delay in seconds before the animation ends + -> IO (Either String ()) +clearCycle mixer (AnimationId id) delay = + checkError (c_clearCycle mixer id (realToFrac delay)) + 0 "clearCycle failed" + +foreign import ccall safe "clearCycle" + c_clearCycle :: Mixer -> CInt -> CFloat -> IO CInt + +-- | Execute an animation once, instead of repeating it. +executeAction :: Mixer + -> AnimationId + -> Float -- ^ delay in + -> Float -- ^ delay out + -> Float -- ^ weight target + -> Bool -- ^ autolock? + -> IO (Either String ()) +executeAction mixer (AnimationId id) delayIn delayOut weightTarget autoLock = + checkError (c_executeAction mixer id + (realToFrac delayIn) + (realToFrac delayOut) + (realToFrac weightTarget) + (fromBool autoLock)) + 0 "executeAction failed" + +foreign import ccall safe "executeAction" + c_executeAction :: Mixer -> CInt -> CFloat -> CFloat -> CFloat -> + CInt -> IO CInt diff --git a/Graphics/Animation/Cal3D/Model.hs b/Graphics/Animation/Cal3D/Model.hs new file mode 100644 --- /dev/null +++ b/Graphics/Animation/Cal3D/Model.hs @@ -0,0 +1,72 @@ +{-# LANGUAGE ForeignFunctionInterface #-} +{-# INCLUDE "cal3d_c.h" #-} + +module Graphics.Animation.Cal3D.Model + (newModel, deleteModel + , attachMesh + , setLodLevel + , setMaterialSet + , getMixer + , update + , getRenderer + ) + +where + +import Foreign +import Foreign.C.Types +import Foreign.C.String + +import Graphics.Animation.Cal3D.Types +import Graphics.Animation.Cal3D.CoreModel +import Graphics.Animation.Cal3D.Error + +-- | Create a new Model instance from a CoreModel. +foreign import ccall safe "newModel" + newModel :: CoreModel -> IO Model + +-- | Destroy a Model. +foreign import ccall safe "deleteModel" + deleteModel :: Model -> IO () + +-- | Attach a mesh to a Model. +attachMesh :: Model -> MeshId -> IO (Either String ()) +attachMesh model (MeshId id) = + checkError (c_attachMesh model id) 0 "failed to attach mesh" + +foreign import ccall safe "attachMesh" + c_attachMesh :: Model -> CInt -> IO CInt + +-- | Set the level of detail for a Model (between 0 and 1). +setLodLevel :: Model -> Float -> IO () +setLodLevel model = c_setLodLevel model . realToFrac + +foreign import ccall safe "setLodLevel" + c_setLodLevel :: Model -> CFloat -> IO () + +-- | Apply a material set to a Model. +setMaterialSet :: Model -> MaterialSetId -> IO () +setMaterialSet model (MaterialSetId id) = + c_setMaterialSet model (fromIntegral id) + +foreign import ccall safe "setMaterialSet" + c_setMaterialSet :: Model -> CInt -> IO () + +-- | Get a Mixer which can animate the Model. +foreign import ccall safe "getMixer" + getMixer :: Model -> IO Mixer + +-- | Let the current animations of a Model run for a specified time. +update :: Model + -> Float -- ^ elapsed time in seconds + -> IO () +update model deltaTime = c_update model (realToFrac deltaTime) + +foreign import ccall safe "update" + c_update :: Model -> CFloat -> IO () + +-- | Get a Renderer for the Model, which can provide information +-- needed for a graphics API. +foreign import ccall safe "getRenderer" + getRenderer :: Model -> IO Renderer + diff --git a/Graphics/Animation/Cal3D/Renderer.hs b/Graphics/Animation/Cal3D/Renderer.hs new file mode 100644 --- /dev/null +++ b/Graphics/Animation/Cal3D/Renderer.hs @@ -0,0 +1,222 @@ +{-# LANGUAGE ForeignFunctionInterface #-} +{-# INCLUDE "cal3d_c.h" #-} + +{- | A Renderer provides information needed for graphics rendering; +it does not output any graphics by itself, but needs the cooperation +of a graphics API. Consider using 'Graphics.Animation.Cal3D.OpenGL' +from the cal3d-opengl package. -} + +module Graphics.Animation.Cal3D.Renderer + (newRenderer, deleteRenderer + , renderAnimation + , getMeshCount, getSubmeshCount + , selectMeshSubmesh + + , CalIndex, getFaceCount, getFaces + , withAmbientColorPtr, withDiffuseColorPtr, withSpecularColorPtr + , getShininess + , getVertexCount, getVertices, getNormals + ) + +where + +import Foreign +import Foreign.C.Types +import Foreign.C.String + +import Graphics.Animation.Cal3D.Types +import Graphics.Animation.Cal3D.Error + +-- | Create a Renderer. +foreign import ccall safe "newRenderer" + newRenderer :: Model -> IO Renderer + +-- | Destroy a Renderer. +foreign import ccall safe "deleteRenderer" + deleteRenderer :: Renderer -> IO () + +{- | Executes a rendering action. + +> renderAnimation renderer action + + corresponds to + +> renderer->beginRendering(); +> action(); +> renderer->endRendering(); + +in the Cal3D C++ API. -} + +renderAnimation :: Renderer + -> IO () -- ^ rendering action + -> IO (Either String ()) +renderAnimation renderer action = do + { + ok <- c_beginRendering renderer + ; result <- + if not (toBool ok) + then return $ Left "renderAnimation: unable to begin rendering" + else do + { + action + ; return $ Right () + } + ; c_endRendering renderer + ; return result + } + +foreign import ccall safe "beginRendering" + c_beginRendering :: Renderer -> IO Int + +foreign import ccall safe "endRendering" + c_endRendering :: Renderer -> IO () + +-- | The number of meshes in the Renderer's 'Model'. +getMeshCount :: Renderer -> IO Int +getMeshCount renderer = + return . fromIntegral =<< c_getMeshCount renderer + +foreign import ccall safe "getMeshCount" + c_getMeshCount :: Renderer -> IO CInt + +-- | The number of submeshes in the given mesh of the Renderer's 'Model'. +getSubmeshCount :: Renderer + -> Int -- ^ mesh ID + -> IO Int +getSubmeshCount renderer meshId = + return . fromIntegral + =<< c_getSubmeshCount renderer (fromIntegral meshId) + +foreign import ccall safe "getSubmeshCount" + c_getSubmeshCount :: Renderer -> CInt -> IO CInt + +{- | Selects a particular (mesh, submesh) so that all subsequent +operations refer to this (mesh, submesh) pair. -} + +selectMeshSubmesh :: Renderer + -> Int -- ^ mesh ID + -> Int -- ^ submesh ID + -> IO (Either String ()) +selectMeshSubmesh renderer meshId submeshId = + checkError (c_selectMeshSubmesh renderer + (fromIntegral meshId) + (fromIntegral submeshId)) + 0 + ("unable to select submesh " ++ (show (meshId, submeshId))) + +foreign import ccall safe "selectMeshSubmesh" + c_selectMeshSubmesh :: Renderer -> CInt -> CInt -> IO CInt + +-- | The number of faces in the current (mesh, submesh). +getFaceCount :: Renderer -> IO Int +getFaceCount renderer = + return . fromIntegral =<< c_getFaceCount renderer + +foreign import ccall safe "getFaceCount" + c_getFaceCount :: Renderer -> IO CInt + +-- | Used to index faces. +type CalIndex = CInt + +-- | Fills a buffer with the face numbers. +getFaces :: Renderer + -> Ptr CalIndex -- ^ buffer + -> IO Int +getFaces renderer ptr = return . fromIntegral =<< c_getFaces renderer ptr + +foreign import ccall safe "getFaces" + c_getFaces :: Renderer -> Ptr CalIndex -> IO CInt + +-- | The number of vertices, also the number of normals, +-- in the current (mesh, submesh). +getVertexCount :: Renderer -> IO Int +getVertexCount renderer = + return . fromIntegral =<< c_getVertexCount renderer + +foreign import ccall safe "getVertexCount" + c_getVertexCount :: Renderer -> IO CInt + +-- | Fills a buffer with the vertex data of the current (mesh, submesh). +getVertices :: Renderer + -> Ptr Float -- ^ buffer + -> Int -- ^ stride + -> IO Int +getVertices renderer ptr stride = + return . fromIntegral =<< c_getVertices renderer ptr (fromIntegral stride) + +foreign import ccall safe "getVertices" + c_getVertices :: Renderer -> Ptr Float -> CInt -> IO CInt + +-- | Fills a buffer with the normal data for the current (mesh, submesh). +getNormals :: Renderer -> Ptr Float -> Int -> IO Int +getNormals renderer buf stride = + return . fromIntegral =<< c_getNormals renderer buf (fromIntegral stride) + +foreign import ccall safe "getNormals" + c_getNormals :: Renderer -> Ptr Float -> Int -> IO CInt + +-- ---------------------------------------------------------------------- +-- Getting colors +-- ---------------------------------------------------------------------- + +-- Intended usage: +-- c_getColor is the C function that "reads" the color, storing 4 bytes +-- into a pointer +-- convert is a function that takes the pointer and converts the +-- 4 bytes into a color suitable for the rendering engine, +-- for example, in OpenGL, Color4 GLfloat. + +withColorPtr :: Storable c => + (Renderer -> Ptr Word8 -> IO ()) -> + (Ptr Word8 -> IO c) -> + Renderer -> IO c +withColorPtr c_getColor convert renderer = + alloca (\ ptr -> do {c_getColor renderer ptr; convert ptr}) + +{- | Calls an action with a pointer to the ambient color data. +The color data are four bytes (red, green, blue, alpha). +If you are using OpenGL, use 'Graphics.Animation.Cal3D.OpenGL.getAmbientColor' +instead. +You almost certainly don't want to use @withAmbientColorPtr@ directly, +unless your are connecting Cal3D to a different graphics API. -} +withAmbientColorPtr :: (Storable c) => + (Ptr Word8 -> IO c) -- ^ action + -> Renderer + -> IO c +withAmbientColorPtr = withColorPtr c_getAmbientColor + +-- | Diffuse color, like 'withAmbientColorPtr'. +withDiffuseColorPtr :: (Storable c) => + (Ptr Word8 -> IO c) -> Renderer -> IO c +withDiffuseColorPtr = withColorPtr c_getDiffuseColor + +-- | Specular color, like 'withAmbientColorPtr'. +withSpecularColorPtr :: (Storable c) => + (Ptr Word8 -> IO c) -> Renderer -> IO c +withSpecularColorPtr = withColorPtr c_getSpecularColor + +foreign import ccall safe "getAmbientColor" + c_getAmbientColor :: Renderer -> Ptr Word8 -> IO () + +foreign import ccall safe "getDiffuseColor" + c_getDiffuseColor :: Renderer -> Ptr Word8 -> IO () + +foreign import ccall safe "getSpecularColor" + c_getSpecularColor :: Renderer -> Ptr Word8 -> IO () + +-- | The shininess, which affects the extent of speculr effects. +getShininess :: Renderer -> IO Float +getShininess = c_getShininess + +foreign import ccall safe "getShininess" + c_getShininess :: Renderer -> IO Float + +-- ------------------------------------------------------------------------ +-- DEBUG AID +-- ------------------------------------------------------------------------ + +foreign import ccall safe "calVectorSize" + dbgCalVectorSize :: IO CInt + +foreign import ccall safe "dumpVertices" + dbgDumpVertices :: Renderer -> IO () diff --git a/Graphics/Animation/Cal3D/Types.hs b/Graphics/Animation/Cal3D/Types.hs new file mode 100644 --- /dev/null +++ b/Graphics/Animation/Cal3D/Types.hs @@ -0,0 +1,71 @@ +{-# LANGUAGE ForeignFunctionInterface #-} +{-# INCLUDE "cal3d_c.h" #-} + +{- |Most (possibly all) data type declarations are collected + here, in order to avoid mutually recursive modules, + like where module Model needs data 'Mixer' from module Mixer, + and module Mixer needs data 'Model' from module Model. +-} + +module Graphics.Animation.Cal3D.Types + ( + CoreModel + , LoadResult, Loader, CLoader + , AnimationId(AnimationId) + , MeshId(MeshId) + , MaterialId(MaterialId) + , MaterialThreadId(..) + , MaterialSetId(..) + , Model + , Mixer + , Renderer + ) + +where + +import Foreign +import Foreign.C.Types +import Foreign.C.String + +{- | A CoreModel is a type which may have multiple +instances ('Model's). See "Graphics.Animation.Cal3D.Model". -} +newtype CoreModel = CoreModel (Ptr CoreModel) + +type CLoader = CoreModel -> CString -> IO CInt + +-- | A function that loads something from a file. +type Loader a = CoreModel -> FilePath -> LoadResult a + +-- | LoadResult is (Left error_message) or (Right thing_loaded_from_file) +type LoadResult a = IO (Either String a) + +-- | Identifies an animation. +newtype AnimationId = AnimationId CInt + +-- | Identifies a mesh. +newtype MeshId = MeshId CInt + deriving (Show, Eq) + +-- | Identifies a material. +newtype MaterialId = MaterialId CInt + +-- | Identifies a material thread. +data MaterialThreadId = MaterialThreadId Int + +-- | Identifies a material set. +data MaterialSetId = MaterialSetId Int + +{- | A Model is an \"instance\" of a 'CoreModel'. +See "Graphics.Animation.Cal3D.Model". -} +newtype Model = Model (Ptr Model) + +{- | A Mixer can blend simultaneous animations and play them. +See "Graphics.Animation.Cal3D.Mixer". -} +newtype Mixer = Mixer (Ptr Mixer) + +{- | A Renderer provides data needed for graphics rendering. +Cal3D does no rendering itself; the Renderer simply provides +the needed information for a graphics API such as OpenGL. +See "Graphics.Animation.Cal3D.Renderer"; +also see the cal3d-opengl package. -} +newtype Renderer = Renderer (Ptr Renderer) diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,461 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,3 @@ +-- Simple setup +import Distribution.Simple +main = defaultMain diff --git a/c++/cal3d_c.cc b/c++/cal3d_c.cc new file mode 100644 --- /dev/null +++ b/c++/cal3d_c.cc @@ -0,0 +1,271 @@ +#include + +#include "cal3d_c.h" + +/* ---------------------------------------------------------------------- + Class CalCoreModel + ---------------------------------------------------------------------- */ + +CoreModelP newCoreModel (char * name) { + return (CoreModelP) new CalCoreModel((const char *) name); +} + + +void deleteCoreModel (CoreModelP model) { + delete (CalCoreModel *) model; +} + + +int loadCoreSkeleton (CoreModelP model, char * path) { + // cast from bool + return (int) + ((CalCoreModel *) model)->loadCoreSkeleton ((const char *) path); +} + +int loadCoreAnimation (CoreModelP model, char * path) { + // -1 = failed + return ((CalCoreModel *) model)->loadCoreAnimation ((const char *) path); + +} + +int loadCoreMesh (CoreModelP model, char * path) { + // -1 = failed + return ((CalCoreModel *) model)->loadCoreMesh ((const char *) path); + +} + +int loadCoreMaterial(CoreModelP model, char * path) { + // -1 = failed + return ((CalCoreModel *) model)->loadCoreMaterial ((const char *) path); + +} + +int createCoreMaterialThread(CoreModelP model, int matl_thread_id) { + // cast from bool + return (int) + ((CalCoreModel *) model)->createCoreMaterialThread(matl_thread_id); +} + +int setCoreMaterialId(CoreModelP model, int matl_thread, int matl_set, + int matl_id) { + // cast from bool + return (int) + ((CalCoreModel *) model)-> + setCoreMaterialId(matl_thread, matl_set, matl_id); +} + +/* ---------------------------------------------------------------------- + Class CalMixer + ---------------------------------------------------------------------- */ + + +MixerP newMixer (ModelP model) { + return (MixerP) new CalMixer((CalModel *) model); +} + +void deleteMixer (MixerP mixer) { + delete (CalMixer *) mixer; +} + +int blendCycle(MixerP mixer, int id, float weight, float delay) { + return (int) + ((CalMixer *) mixer) -> + blendCycle(id, weight, delay); +} + +int clearCycle (MixerP mixer, int id, float delay) { + return (int) + ((CalMixer *) mixer) -> + clearCycle(id, delay); + +} + +int executeAction (MixerP mixer, int id, float delayIn, float delayOut, + float weightTarget, int autoLock) { + return (int) + ((CalMixer *) mixer) -> + executeAction (id, delayIn, delayOut, weightTarget, autoLock); + +} + + +/* ---------------------------------------------------------------------- + Class CalModel + ---------------------------------------------------------------------- */ + +ModelP newModel (CoreModelP coreModel) { + return (ModelP) new CalModel((CalCoreModel *) coreModel); +} + +void deleteModel (ModelP model) { + delete (CalModel *) model; + +} + +int attachMesh (ModelP model, int coreMeshId) { + // cast from bool + return (int) + ((CalModel *) model)->attachMesh(coreMeshId); +} + +void setLodLevel (ModelP model, float lodLevel) { + ((CalModel *) model)->setLodLevel(lodLevel); +} + +void setMaterialSet (ModelP model, int setId) { + ((CalModel *) model)->setMaterialSet(setId); +} + +MixerP getMixer (ModelP model) { + return (MixerP) + ((CalModel *) model)->getMixer(); +} + +/* update model for deltaTime seconds */ +void update (ModelP model, float deltaTime) { + ((CalModel *) model)->update(deltaTime); +} + +RendererP getRenderer (ModelP model) { + return (RendererP) + ((CalModel *) model)->getRenderer(); +} + +/* ---------------------------------------------------------------------- + Class CalRenderer + ---------------------------------------------------------------------- */ + + +RendererP newRenderer (ModelP model) { + return (RendererP) new CalRenderer ((CalModel *) model); +} + +void deleteRenderer(RendererP renderer) { + delete (CalRenderer *) renderer; +} + +int beginRendering (RendererP renderer) { + /* cast from bool */ + return (int) + ((CalRenderer *) renderer) -> beginRendering(); +} + +void endRendering (RendererP renderer) { + ((CalRenderer *) renderer) -> endRendering(); +} + + +void getAmbientColor(RendererP renderer, unsigned char *pColorBuffer) { + ((CalRenderer *) renderer) -> getAmbientColor(pColorBuffer); +} + +void getDiffuseColor(RendererP renderer, unsigned char *pColorBuffer) { + ((CalRenderer *) renderer) -> getDiffuseColor(pColorBuffer); +} + +void getSpecularColor(RendererP renderer, unsigned char *pColorBuffer) { + ((CalRenderer *) renderer) -> getSpecularColor(pColorBuffer); +} + +float getShininess (RendererP renderer) { + return ((CalRenderer *) renderer) -> getShininess(); +} + +/* + int getMapCount(RendererP renderer); + Cal::UserData getMapUserData(RendererP renderer, int mapId); +*/ + +int getMeshCount(RendererP renderer) { + return ((CalRenderer *)renderer) -> getMeshCount(); +} + +/* + int getNormals(RendererP renderer, float *pNormalBuffer, int stride=0); + float getShininess(RendererP renderer); + void getSpecularColor(RendererP renderer, unsigned char *pColorBuffer); +*/ + +int getSubmeshCount(RendererP renderer, int meshId) { + return ((CalRenderer *) renderer) -> getSubmeshCount(meshId); +} + + +/* + int getTextureCoordinates(RendererP renderer, int mapId, + float *pTextureCoordinateBuffer, int stride); +*/ + + +int getFaceCount(RendererP renderer) { + return ((CalRenderer *)renderer) -> getFaceCount(); +} + +/* Writes to pFaceBuffer, affected by LOD setting; + returns number of faces written to the buffer */ + +int getFaces(RendererP renderer, CalIndex *pFaceBuffer) { + return ((CalRenderer *) renderer) -> getFaces(pFaceBuffer); +} + +int getVertexCount(RendererP renderer) { + return ((CalRenderer *) renderer) -> getVertexCount(); +} + +/* getVertices side-effects pVertexBuffer and returns the + number of vertices written to the buffer */ + +int getVertices(RendererP renderer, float *pVertexBuffer, int stride=0) { + return ((CalRenderer *) renderer) -> getVertices(pVertexBuffer, stride); +} + +int getNormals(RendererP renderer, float *pNormalBuffer, int stride) { + return ((CalRenderer *) renderer) -> getNormals(pNormalBuffer, stride); +} + +/* + int getTangentSpaces(RendererP renderer, int mapId, + float *pTangentSpaceBuffer, int stride); + int getVerticesAndNormals(RendererP renderer, + float *pVertexBuffer, int stride); + int getVerticesNormalsAndTexCoords(RendererP renderer, + float *pVertexBuffer,int NumTexCoords); + bool isTangentsEnabled(RendererP renderer, int mapId); +*/ + +int selectMeshSubmesh(RendererP renderer, int meshId, int submeshId) { + return (int) /* cast from bool */ + ((CalRenderer *) renderer) -> selectMeshSubmesh(meshId, submeshId); +} + +/* + void setNormalization(RendererP renderer, bool normalize); +*/ + +/* ------------------------------------------------------------------------ + DEBUG AIDS + ------------------------------------------------------------------------ */ + +int calVectorSize () { + CalVector v; + return sizeof v; +} + +void dumpVertices (RendererP renderer) { + static float vtx [30000][3]; + int n = 0; + CalRenderer * calRenderer = (CalRenderer *) renderer; + n = calRenderer->getVertexCount(); + std::cerr << "Got " << n << " vertices\n"; + + /* NEXT STATEMENT SEGFAULTS, also with optional arg 0, 3, or 12 */ + /* n = calRenderer->getVertices(&vtx[0][0]); */ + n = calRenderer->getVertices(&vtx[0][0], 12); + + std::cerr << "Got " << n << " vertices\n"; + /* getVertices(renderer, vtx, 3); + for (int i = 0; i < n; i++) { + std::cerr << i << ": " << vtx[i] << "\nl"; + } + */ +} diff --git a/c++/cal3d_c.h b/c++/cal3d_c.h new file mode 100644 --- /dev/null +++ b/c++/cal3d_c.h @@ -0,0 +1,154 @@ +/* File: cal3d_c.h */ + +#ifndef CAL3D_C_H +#define CAL3D_C_H + +#ifdef __cplusplus +extern "C" { +#endif + + /* ---------------------------------------------------------------------- + All object types declared here + ---------------------------------------------------------------------- */ + + typedef struct CoreModelS CoreModelS; + typedef CoreModelS * CoreModelP; + + typedef struct MixerS MixerS; + typedef MixerS * MixerP; + + typedef struct ModelS ModelS; + typedef ModelS * ModelP; + + typedef struct RendererS RendererS; + typedef RendererS * RendererP; + + + /* ---------------------------------------------------------------------- + /* Methods of class CalCoreModel + (see coremodel.h in the Cal3D source code) + ---------------------------------------------------------------------- */ + + + CoreModelP newCoreModel (char * name); + void deleteCoreModel (CoreModelP model); + + int loadCoreSkeleton (CoreModelP model, char * path); + int loadCoreAnimation (CoreModelP model, char * path); + int loadCoreMesh (CoreModelP model, char * path); + int loadCoreMaterial(CoreModelP model, char * path); + int createCoreMaterialThread(CoreModelP model, int matl_thread_id); + int setCoreMaterialId(CoreModelP model, int matl_thread, int matl_set, + int matl_id); + + /* ---------------------------------------------------------------------- + Methods of class CalMixer + (see mixer.h in the Cal3D source code) + ---------------------------------------------------------------------- */ + + + + MixerP newMixer (ModelP model); + void deleteMixer (MixerP mixer); + + int blendCycle(MixerP mixer, int id, float weight, float delay); + int clearCycle (MixerP mixer, int id, float delay); + int executeAction (MixerP mixer, int id, float delayIn, float delayOut, + float weightTarget, int autoLock); + + /* ---------------------------------------------------------------------- + Methods of class CalModel + (see model.h in the Cal3D source code) + ---------------------------------------------------------------------- */ + + ModelP newModel (CoreModelP coreModel); + void deleteModel (ModelP model); + + int attachMesh (ModelP model, int coreMeshId); + void setLodLevel (ModelP model, float lodLevel); + void setMaterialSet (ModelP model, int setId); + + MixerP getMixer (ModelP model); + + void update (ModelP model, float deltaTime); /* seconds */ + + RendererP getRenderer (ModelP model); + + /* ---------------------------------------------------------------------- + Methods of class CalRenderer + (see renderer.h in the Cal3D source code) + ---------------------------------------------------------------------- */ + + RendererP newRenderer (ModelP model); + void deleteRenderer(RendererP renderer); + + int beginRendering (RendererP renderer); + void endRendering (RendererP renderer); + + void getAmbientColor(RendererP renderer, unsigned char *pColorBuffer); + void getDiffuseColor(RendererP renderer, unsigned char *pColorBuffer); + void getSpecularColor(RendererP renderer, unsigned char *pColorBuffer); + + float getShininess (RendererP renderer); + + /* + int getMapCount(RendererP renderer); + Cal::UserData getMapUserData(RendererP renderer, int mapId); + */ + + int getMeshCount(RendererP renderer); + + /* + float getShininess(RendererP renderer); + void getSpecularColor(RendererP renderer, unsigned char *pColorBuffer); + */ + + int getSubmeshCount(RendererP renderer, int meshId); + + /* + int getTextureCoordinates(RendererP renderer, int mapId, + float *pTextureCoordinateBuffer, int stride); + */ + + + int getFaceCount(RendererP renderer); + int getFaces(RendererP renderer, CalIndex *pFaceBuffer); + + int getVertexCount(RendererP renderer); + /* C++ default stride = 0 */ + int getVertices(RendererP renderer, float *pVertexBuffer, int stride); + /* C++ default stride = 0 */ + int getNormals(RendererP renderer, float *pNormalBuffer, int stride); + + /* + int getTangentSpaces(RendererP renderer, int mapId, + float *pTangentSpaceBuffer, int stride); + int getVerticesAndNormals(RendererP renderer, + float *pVertexBuffer, int stride); + int getVerticesNormalsAndTexCoords(RendererP renderer, + float *pVertexBuffer,int NumTexCoords); + bool isTangentsEnabled(RendererP renderer, int mapId); + */ + + /* int interpreted as bool */ + int selectMeshSubmesh(RendererP renderer, int meshId, int submeshId); + + /* + void setNormalization(RendererP renderer, bool normalize); + */ + + /* -------------------------------------------------------------------- + DEBUG AID + -------------------------------------------------------------------- */ + + + int calVectorSize (); + + void dumpVertices (RendererP renderer); + + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/cal3d.cabal b/cal3d.cabal new file mode 100644 --- /dev/null +++ b/cal3d.cabal @@ -0,0 +1,55 @@ +name: cal3d +version: 0.1 +cabal-version: >= 1.6 +build-type: Simple +-- The C++ Cal3D library is LGPLed, so that makes sense here too +license: LGPL +license-file: LICENSE +author: Gregory D. Weber +maintainer: let at = "@" in concat ["gdweber", at, "iue.edu"] +stability: experimental +homepage: http://haskell.org/haskellwiki/Cal3d_animation +category: Graphics, Animation +tested-with: GHC == 6.10.1 +synopsis: Haskell binding to the Cal3D animation library. +description: + Haskell binding to the Cal3D, a skeletal-based animation + library written in C++. + See also the related packages cal3d-opengl and cal3d-examples. + +-- extra-source-files: *list-of-files* (not including directories) + +-- extra-source-files: +-- c++/cal3d_c.h +library + build-depends: + base >= 4.0.0.0 && < 5 + exposed-modules: Graphics.Animation.Cal3D + Graphics.Animation.Cal3D.CoreModel + Graphics.Animation.Cal3D.Model + Graphics.Animation.Cal3D.Mixer + Graphics.Animation.Cal3D.Types + Graphics.Animation.Cal3D.Error + Graphics.Animation.Cal3D.Renderer + exposed: True + other-modules: + + extensions: ForeignFunctionInterface + + -- Is there a better way to require compilation by a C++ compiler? + -- e.g. for another OS (Windows?) and/or another Haskell system (Hugs, etc.) + -- Maybe this isn't necessary? + -- ghc-options: -pgmc g++ + -- ?? hugs-options: + -- ?? nhc98-options: + + c-sources: c++/cal3d_c.cc + includes: cal3d/cal3d.h + install-includes: cal3d_c.h + include-dirs: c++ + + -- For running hsc2hs separately, you need also -I /usr/lib/ghc-6.10.1/include + extra-libraries: cal3d + + +