oZone3D.Net - Demoniak3D Developer Guide

Demoniak3D/LUA API: General organisation

The Demoniak3D/LUA API (Application Programming Interface) is the whole set of the functions that let a program written in LUA scripting language to exchange data and handle actions with Demoniak3D:

A lua scripting code may be integrated within the XML code of a Hypergraph in several ways, using the following nodes:

with the <script> node: it is the most direct and the simplest way.
with the <hotkey> node: a LUA script is launched when pressing a key.
with the <interval> node: LUA scripts are lauched whether at the beginning or during the interval.
with the <mouse> node: LUA scripts may be lauched in risponse to the mouse events.
with the <play_list> node: LUA scripts may be lauched with each audio track of the playlist.
with the <sequence> node: LUA scripts may be lauched within the actions.
with the <timer> node: a LUA script is launched at each time-out.

Here is a very simple LUA script code which displays the output of the classic programming code: "Hello World!":

--
-- This is a comment.
-- This is the Hello World of the LUA programming.
--
text = "Hello World!";
HYP_MsgBox( "Test LUA", text );

In order to run this script, just insert the following code in the Demoniak3D main XML source code:

<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<demoniak3d>

<scene name="training_scene" display_fps="TRUE" show_ref_grid="TRUE" >
	<window_size width="400" height="300" />
	<background_color r="0.0" g="0.0" b="0.0" />
</scene>

<camera name="my_camera" navigation_mode="FLY" fov="50.0" >
	<position x="0.0" y="50.0" z="150.0" />
</camera>

<script name="hello_wolrd_script" 
filename="scripts/hello_world.lua" run_mode="EXECUTE_ONCE" />

</demoniak3d>

This piece of code assumes that the LUA script file has been saved in the scripts/ directory located at the same level as the main XML script file. When loading the XML script in Demoniak3D, the following dialog box appears:

API functions list

The current API contains about two hundreds functions without considering the Novodex physics engine functions. They are classified by type of activity :

Debug Lib

HYP_Debug.Trace

Misc Functions

HYP_GetHyperionVersion
HYP_DrawText
HYP_GetElapsedTime
HYP_GetElapsedTimeSeconds
HYP_GetElapsedTimeMilliSeconds
HYP_GetElapsedTimeMicroSeconds
HYP_GetTimeStep
HYP_GetBaseDir
HYP_GetHyperionDir
HYP_MsgBox
HYP_OpenHTML
HYP_StopApp
HYP_Wait
HYP_GetGCModelString
HYP_GetGCVendorString
HYP_IsATI
HYP_IsNVIDIA
HYP_Project3DTo2D
HYP_Project2DTo3D

Object Lib

HYP_Object.AbsoluteToLocal
HYP_Object.AddChild
HYP_Object.AttachTexture
HYP_Object.AverageNormals
HYP_Object.Check_AABB_Collision
HYP_Object.Check_BS_Collision
HYP_Object.ClearAllMaterials
HYP_Object.Clone
HYP_Object.ComputeNormals
HYP_Object.ComputeTangentSpace
HYP_Object.DetachAllTextures
HYP_Object.DetachTexture
HYP_Object.DisplayBoundingVolume
HYP_Object.DisplayTripod
HYP_Object.FreeAllTextures
HYP_Object.GetBoundingVolumeAbsoluteCenter
HYP_Object.GetAbsolutePosition
HYP_Object.GetAbsoluteTransformMatrix
HYP_Object.GetAbsolute_X_Axis
HYP_Object.GetAbsolute_Y_Axis
HYP_Object.GetAbsolute_Z_Axis
HYP_Object.GetActiveState
HYP_Object.GetBackFaceCullingState
HYP_Object.GetBlendingState
HYP_Object.GetBlendingFactors
HYP_Object.GetChild
HYP_Object.GetChildByIndex
HYP_Object.GetDepthBufferState
HYP_Object.GetDirection
HYP_Object.GetDistanceBetween
HYP_Object.GetIdFromName
HYP_Object.GetLightingState
HYP_Object.GetNameFromId
HYP_Object.GetNumChildren
HYP_Object.GetPosition
HYP_Object.GetRenderState
HYP_Object.GetSize
HYP_Object.GetParent
HYP_Object.GetPickingState
HYP_Object.GetTexturingState
HYP_Object.GetUpdateState
HYP_Object.GetUpdateTripodDirectionState
HYP_Object.IsTypeOf
HYP_Object.PopTripod
HYP_Object.PushTripod
HYP_Object.RemoveChild
HYP_Object.RemoveSeam
HYP_Object.Render
HYP_Object.ResetTripod
HYP_Object.RotateObject
HYP_Object.SetAlphaMappedState
HYP_Object.SetActiveState
HYP_Object.SetBackFaceCullingState
HYP_Object.SetBlendingFactors
HYP_Object.SetBlendingState
HYP_Object.SetColor
HYP_Object.SetDepthBufferState
HYP_Object.SetDepthBufferWritingState
HYP_Object.SetDirection
HYP_Object.SetLightingState
HYP_Object.SetLineWidth
HYP_Object.SetMaterial
HYP_Object.SetNormalizationState
HYP_Object.SetOrientation
HYP_Object.SetPickingState
HYP_Object.SetPitch
HYP_Object.SetPolygonMode
HYP_Object.SetPosition
HYP_Object.SetReflectionState
HYP_Object.SetRenderState
HYP_Object.SetRoll
HYP_Object.SetScale
HYP_Object.SetShadowCasterState
HYP_Object.SetTexturingState
HYP_Object.SetUpdateState
HYP_Object.SetUpdateTripodDirectionState
HYP_Object.SetVBOState
HYP_Object.SetYaw
HYP_Object.Translate
HYP_Object.Update
HYP_Object.UpdateGeometryData
HYP_Object.UpdateTripod

Models Lib

HYP_Model.GetFirstSubMesh
HYP_Model.GetSubMeshByName
HYP_Model.Load
HYP_Model.LoadAmbientOcclusionMap
HYP_Model.ScaleVertices
HYP_Model.Save
HYP_Model.SetVerticesColor
HYP_Model.SetCloningMode
HYP_Model.GetNumFaces
HYP_Model.GetNumVertices

Meshes Lib

HYP_Mesh.CastRay
HYP_Mesh.CopyVerticesList
HYP_Mesh.CreateBox
HYP_Mesh.CreatePlane
HYP_Mesh.CreateSphere
HYP_Mesh.CreateTorus
HYP_Mesh.DoTweening
HYP_Mesh.FlipNormals
HYP_Mesh.GetElevation
HYP_Mesh.GetFaceIndexes
HYP_Mesh.GetFaceNormal
HYP_Mesh.GetNumFaces
HYP_Mesh.GetNumPlaneSegments
HYP_Mesh.GetNumVertices
HYP_Mesh.GetVertexAttrib
HYP_Mesh.GetVertexColor
HYP_Mesh.GetVertexNormal
HYP_Mesh.GetVertexPosition
HYP_Mesh.GetVertexUVCoords
HYP_Mesh.PopVerticesList
HYP_Mesh.PushVerticesList
HYP_Mesh.ScaleVertices
HYP_Mesh.SetTexCoordsOffset
HYP_Mesh.SetTexCoordsTiling
HYP_Mesh.SetPivotPosition
HYP_Mesh.SetPivotOrientation
HYP_Mesh.SetVertexAttrib
HYP_Mesh.SetVertexColor
HYP_Mesh.SetVerticesColor
HYP_Mesh.SetVertexNormal
HYP_Mesh.SetVertexPosition
HYP_Mesh.SetVertexUVCoords
HYP_Mesh.UpdateAllNormals
HYP_Mesh.UpdateFaceNormalField
HYP_Mesh.UpdateVertexNormalField
HYP_Mesh.VBQuad_AddQuad
HYP_Mesh.VBQuad_SetQuadVertexPosition
HYP_Mesh.VBQuad_GetQuadVertexPosition
HYP_Mesh.VBQuad_SetQuadVertexColor
HYP_Mesh.VBQuad_GetQuadVertexColor
HYP_Mesh.VBQuad_SortFacesInCameraSpace
HYP_Mesh.Destroy
HYP_Mesh.GetFaceCenterPosition

Cameras Lib

HYP_Camera.PositionMoveAlongDirection
HYP_Camera.PositionStrafeHorizontal
HYP_Camera.PositionStrafeVertical
HYP_Camera.Disable
HYP_Camera.Enable
HYP_Camera.GetFarPlane
HYP_Camera.GetFOV
HYP_Camera.GetKeyboardSpeed
HYP_Camera.GeLookAtDirection
HYP_Camera.GetNearPlane
HYP_Camera.GetPosition
HYP_Camera.MakeScreenshot
HYP_Camera.SetScreenshotsDirectory
HYP_Camera.SetFarPlane
HYP_Camera.SetFOV
HYP_Camera.SetKeyboardSpeed
HYP_Camera.SetLookAt
HYP_Camera.SetNearPlane
HYP_Camera.SetOrientation
HYP_Camera.SetPitch
HYP_Camera.SetPosition
HYP_Camera.SetRoll
HYP_Camera.SetTarget
HYP_Camera.SetViewParams
HYP_Camera.SetYaw
HYP_Camera.ShakePosition
HYP_Camera.GetNumCameras
HYP_Camera.GetIdByIndex
HYP_Camera.GetNameByIndex
HYP_Camera.GetId
HYP_Camera.GetName
HYP_Camera.GetProjectionMatrix
HYP_Camera.GetViewMatrix
HYP_Camera.SetViewport
HYP_Camera.GetViewport
HYP_Camera.SetBkgColor

Lighting Lib

HYP_Lighting.GetAmbient
HYP_Lighting.GetDiffuse
HYP_Lighting.GetSpecular
HYP_Lighting.SetAmbient
HYP_Lighting.SetDiffuse
HYP_Lighting.SetSpecular
HYP_Lighting.SetConstantAttFactor
HYP_Lighting.SetLinearAttFactor
HYP_Lighting.SetQuadraticAttFactor
HYP_Lighting.Create
HYP_Lighting.Destroy
HYP_Lighting.SetType
HYP_Lighting.SetSpotCutOff
HYP_Lighting.GetSpotCutOff
HYP_Lighting.GetNumLights
HYP_Lighting.GetIdByIndex
HYP_Lighting.GetNameByIndex
HYP_Lighting.GetId
HYP_Lighting.GetName
HYP_Lighting.SetShadowEmitterState

Materials Lib

HYP_Material.Create
HYP_Material.Destroy
HYP_Material.SetAmbient
HYP_Material.SetDiffuse
HYP_Material.SetDynamicFriction
HYP_Material.SetResilience
HYP_Material.SetSelfIllumination
HYP_Material.SetSpecular
HYP_Material.SetSpecularExp
HYP_Material.SetStaticFriction
HYP_Material.GetNumMaterials
HYP_Material.GetIdByIndex
HYP_Material.GetNameByIndex
HYP_Material.GetId
HYP_Material.GetName
HYP_Material.AttachTexture
HYP_Material.DetachTexture
HYP_Material.SetShaderProgram
HYP_Material.SetShaderProgramForAmbientPass
HYP_Material.GetTextureId

Texture Lib

HYP_Texture.SetAddressingMode
HYP_Texture.SetFilteringAnisotropicValue
HYP_Texture.SetFilteringMode
HYP_Texture.SetFunction
HYP_Texture.Save
HYP_Texture.LoadTex2D
HYP_Texture.LoadTex2DAvi
HYP_Texture.Create
HYP_Texture.Destroy
HYP_Texture.SetName
HYP_Texture.SetValueTex1DByteRgb
HYP_Texture.SetValueTex1DFloatRgba
HYP_Texture.SetValueTex2DByteRgb
HYP_Texture.SetValueTex2DFloatRgba
HYP_Texture.GetValueTex1DByteRgb
HYP_Texture.GetValueTex1DFloatRgba
HYP_Texture.GetValueTex2DByteRgb
HYP_Texture.GetValueTex2DFloatRgba
HYP_Texture.GetDimensions
HYP_Texture.SetTransformMatrix
HYP_Texture.GetTransformMatrix
HYP_Texture.PlayStopAVI
HYP_Texture.GetAVINumFrames
HYP_Texture.GetAVIMpf
HYP_Texture.GetAVICurrentTime
HYP_Texture.SetAVICurrentFrame
HYP_Texture.GetAVICurrentFrame
HYP_Texture.GetIdFromName

Skyboxes Lib

HYP_SetActiveSkybox

Sound Lib

HYP_Sound.Disable_DSP_Unit
HYP_Sound.Enable_DSP_Unit
HYP_Sound.GetSpectrumValue
HYP_Sound.GetTrackTime
HYP_Sound.GetVolume
HYP_Sound.IsTrackFinished
HYP_Sound.Play
HYP_Sound.SetVolume
HYP_Sound.Stop
HYP_Sound.SetSourcePosition
HYP_Sound.SetListenerPosition
HYP_Sound.SetListenerOrientation
HYP_Sound.Load
HYP_Sound.Unload

HUDs Lib

HYP_Hud.DoFadeInOut
HYP_Hud.ProgressiveDisplay
HYP_Hud.ProgressiveUnDisplayWithStretch
HYP_Hud.GetVertexColor
HYP_Hud.GetVertexPosition
HYP_Hud.SetVertexColor
HYP_Hud.SetVertexPosition
HYP_Hud.SetSize
HYP_Hud.GetSize
HYP_Hud.PushVertices
HYP_Hud.PopVertices
HYP_Hud.SetVertexTexCoord
HYP_Hud.GetVertexTexCoord
HYP_Hud.Create
HYP_Hud.Destroy

Primitives Lib

HYP_Primitive.SetBoxSize
HYP_Primitive.SetBoxVertexPosition
HYP_Primitive.GetBoxVertexPosition
HYP_Primitive.SetBoxVertexColor
HYP_Primitive.GetBoxVertexColor
HYP_Primitive.PushBoxVertices
HYP_Primitive.PopBoxVertices
HYP_Primitive.SetQuadVertexPosition
HYP_Primitive.GetQuadVertexPosition
HYP_Primitive.SetQuadVertexColor
HYP_Primitive.GetQuadVertexColor
HYP_Primitive.CreateLine
HYP_Primitive.SetLineVertexPosition
HYP_Primitive.GetLineVertexPosition
HYP_Primitive.SetLineVertexColor
HYP_Primitive.GetLineVertexColor
HYP_Primitive.CreateBox
HYP_Primitive.SetBoxVertexTexCoords
HYP_Primitive.GetBoxVertexTexCoords
HYP_Primitive.CreateQuad
HYP_Primitive.SetQuadVertexTexCoords
HYP_Primitive.GetQuadVertexTexCoords
HYP_Primitive.CreateTriangle
HYP_Primitive.SetTriangleVertexPosition
HYP_Primitive.GetTriangleVertexPosition
HYP_Primitive.SetTriangleVertexColor
HYP_Primitive.GetTriangleVertexColor
HYP_Primitive.SetTriangleVertexTexCoords
HYP_Primitive.GetTriangleVertexTexCoords
HYP_Primitive.CreateDisc
HYP_Primitive.SetDiscParams
HYP_Primitive.GetDiscParams
HYP_Primitive.CreateSphere
HYP_Primitive.SetSphereParams
HYP_Primitive.GetSphereParams
HYP_Primitive.Destroy

Particle System Lib

HYP_ParticleSystem.DisableEmitterEmission
HYP_ParticleSystem.SetEmitterSpawnVecMax
HYP_ParticleSystem.SetEmitterSpawnVecMin
HYP_ParticleSystem.Disable
HYP_ParticleSystem.EnableEmitterEmission
HYP_ParticleSystem.Enable
HYP_ParticleSystem.SetEmitterMasterObject

Scene Lib

HYP_Scene.ActiveBkgImage
HYP_Scene.SetBackgroundColor
HYP_Scene.EnableFog
HYP_Scene.DisableFog
HYP_Scene.Render
HYP_Scene.SetRenderTarget
HYP_Scene.SetRenderTargetTexture
HYP_Scene.AddObject
HYP_Scene.DisableGroup
HYP_Scene.EnableGroup
HYP_Scene.RemoveObject
HYP_Scene.PickMesh
HYP_Scene.FboGetDefault
HYP_Scene.FboBind
HYP_Scene.FboSetRenderDestination
HYP_Scene.FboAttachTexture
HYP_Scene.FboAllocReadBufferRgba32f
HYP_Scene.FboFreeReadBufferRgba32f
HYP_Scene.FboGetValueReadBufferRgba32f
HYP_Scene.NvSliGetNumGpus
HYP_Scene.NvSliSetState
HYP_Scene.NvSliGetState
HYP_Scene.NvSliSetMode
HYP_Scene.NvSliGetMode
HYP_Scene.GetRayOriginAndDirection
HYP_Scene.LoadXml
HYP_Scene.GetWindowSize
HYP_Scene.CastRay

Export Lib

HYP_Export.HYP_ExportSceneForRenderer

Real Time Shaders Lib

HYP_GPUShader.Activate
HYP_GPUShader.Desactivate
HYP_GPUShader.SetConstant_1i
HYP_GPUShader.SetConstant_2i
HYP_GPUShader.SetConstant_3i
HYP_GPUShader.SetConstant_4i
HYP_GPUShader.AllocArray_1iv
HYP_GPUShader.SetArrayElement_1iv
HYP_GPUShader.AllocArray_2iv
HYP_GPUShader.SetArrayElement_2iv
HYP_GPUShader.AllocArray_3iv
HYP_GPUShader.SetArrayElement_3iv
HYP_GPUShader.AllocArray_4iv
HYP_GPUShader.SetArrayElement_4iv
HYP_GPUShader.SetConstant_1f
HYP_GPUShader.SetConstant_2f
HYP_GPUShader.SetConstant_3f
HYP_GPUShader.SetConstant_4f
HYP_GPUShader.AllocArray_1fv
HYP_GPUShader.SetArrayElement_1fv
HYP_GPUShader.AllocArray_2fv
HYP_GPUShader.SetArrayElement_2fv
HYP_GPUShader.AllocArray_3fv
HYP_GPUShader.SetArrayElement_3fv
HYP_GPUShader.AllocArray_4fv
HYP_GPUShader.SetArrayElement_4fv
HYP_GPUShader.SetConstant_4x4f

Scripts Lib

HYP_Script.Exec
HYP_Script.Enable
HYP_Script.Disable

User Input Lib

HYP_Input.DisableDefaultKeyboardFunctionalities
HYP_Input.EnableDefaultKeyboardFunctionalities
HYP_Input.GetJoystickButtonState
HYP_Input.GetJoystickPosition
HYP_Input.GetKeyboardLayout
HYP_Input.GetMouseButtonState
HYP_Input.GetMousePos
HYP_Input.GetMouseWheelDelta
HYP_Input.HideMouseCursor
HYP_Input.IsKeyboardKeyPressed
HYP_Input.IsJoystickEnabled
HYP_Input.ShowMouseCursor
HYP_Input.SetDefaultInputManagementState
HYP_Input.GetDefaultInputManagementState

Motion-Paths Lib

HYP_MotionPath.GetValueByTime
HYP_MotionPath.GetObjectCurrentTime
HYP_MotionPath.Attach

Physics Engine Lib

HYP_Nx_Physics.AddBoxActorToScene
HYP_Nx_Physics.AddForceAtPosToActor
HYP_Nx_Physics.AddForceToActor
HYP_Nx_Physics.AddMeshActorToScene
HYP_Nx_Physics.AddSphereActorToScene
HYP_Nx_Physics.AddTorqueToActor
HYP_Nx_Physics.ForceActorToSleep
HYP_Nx_Physics.GetActorAngularDamping
HYP_Nx_Physics.GetActorAngularVelocity
HYP_Nx_Physics.GetActorCollisionPoint
HYP_Nx_Physics.GetActorCollisionState
HYP_Nx_Physics.GetActorGlobalPosition
HYP_Nx_Physics.GetActorInertiaTensor
HYP_Nx_Physics.GetActorKinematicState
HYP_Nx_Physics.GetActorLinearDamping
HYP_Nx_Physics.GetActorLinearVelocity
HYP_Nx_Physics.GetActorMass
HYP_Nx_Physics.GetActorNumCollisionPoints
HYP_Nx_Physics.GetActorSleepAngularVelocity
HYP_Nx_Physics.GetActorSleepLinearVelocity
HYP_Nx_Physics.GetPhysXEngineVersion
HYP_Nx_Physics.GetSceneGravity
HYP_Nx_Physics.IsActorSleeping
HYP_Nx_Physics.JointAddLimitPlane
HYP_Nx_Physics.JointCreateCylindrical
HYP_Nx_Physics.JointCreateDistance
HYP_Nx_Physics.JointCreateFixed
HYP_Nx_Physics.JointCreateRevolute
HYP_Nx_Physics.JointCreateSpherical
HYP_Nx_Physics.JointDestroy
HYP_Nx_Physics.JointIsBroken
HYP_Nx_Physics.JointPurgeLimitPlanes
HYP_Nx_Physics.JointSetBreakableParams
HYP_Nx_Physics.JointSetGlobalAnchor
HYP_Nx_Physics.JointSetGlobalAxis
HYP_Nx_Physics.JointSetLimitPoint
HYP_Nx_Physics.JointSetMotorParams
HYP_Nx_Physics.JointSetSphericalParams
HYP_Nx_Physics.JointSetSpringParams
HYP_Nx_Physics.MoveActorGlobalOrientation
HYP_Nx_Physics.MoveActorGlobalPosition
HYP_Nx_Physics.RemoveActorFromScene
HYP_Nx_Physics.SetActorInertiaTensor
HYP_Nx_Physics.SetActorKinematicState
HYP_Nx_Physics.SetActorLinearVelocity
HYP_Nx_Physics.SetActorLinearDamping
HYP_Nx_Physics.SetActorAngularVelocity
HYP_Nx_Physics.SetActorAngularDamping
HYP_Nx_Physics.SetActorGlobalPosition
HYP_Nx_Physics.SetActorGlobalOrientation
HYP_Nx_Physics.SetActorGravityState
HYP_Nx_Physics.SetActorMass
HYP_Nx_Physics.SetActorMaxAngularVelocity
HYP_Nx_Physics.SetActorPairFlags
HYP_Nx_Physics.SetActorSleepLinearVelocity
HYP_Nx_Physics.SetActorSleepAngularVelocity
HYP_Nx_Physics.SetPhysicsEnginePauseSimultationState
HYP_Nx_Physics.SetSceneGravity
HYP_Nx_Physics.SetSkinWidthParam
HYP_Nx_Physics.SetTimingParams
HYP_Nx_Physics.WakeUpActor

Projectors Lib

HYP_Projector.Enable
HYP_Projector.Disable
HYP_Projector.SetPosition
HYP_Projector.SetOrientation

Curves Lib

HYP_Curve.GetNumPoints
HYP_Curve.GetValue
HYP_Curve.SetColor
HYP_Curve.SetValue

Playlists Lib

HYP_Playlist.Create
HYP_Playlist.Destroy
HYP_Playlist.AddTrack
HYP_Playlist.RemoveTrack
HYP_Playlist.SetCurrentTrack
HYP_Playlist.GetCurrentTrackId
HYP_Playlist.GetCurrentTrackName
HYP_Playlist.Play
HYP_Playlist.Stop
HYP_Playlist.SetOptions

VertexPool Lib

HYP_VertexPool.Create
HYP_VertexPool.Destroy
HYP_VertexPool.SetVertexPosition
HYP_VertexPool.GetVertexPosition
HYP_VertexPool.SetVertexColor
HYP_VertexPool.GetVertexColor
HYP_VertexPool.SetVerticesColor
HYP_VertexPool.SetVerticesSize
HYP_VertexPool.SetPointSpriteDistAtt
HYP_VertexPool.SetUseOfVertexRenderingState
HYP_VertexPool.SetVertexRenderingState

Lens Flares Lib

HYP_LensFlares.Init
HYP_LensFlares.Deinit
HYP_LensFlares.AddFlare
HYP_LensFlares.AddFlaresSource
HYP_LensFlares.SetIntensityFactor