jop Namespace Reference

Namespaces
	gl

Classes
class	AnimatedSprite
class	AnimationAtlas
class	AudioDevice
class	BoxMesh
class	BoxShape
class	Buffer
class	Camera
class	CapsuleMesh
class	CapsuleShape
class	CapsuleShape2D
class	CircleMesh
class	CircleShape2D
class	Clock
class	Collider
class	Collider2D
class	CollisionShape
class	CollisionShape2D
class	Color
class	CommandHandler
class	Component
class	CompoundShape
class	CompoundShape2D
class	ConeMesh
class	ConeShape
class	ConeShape2D
class	ContactInfo
class	ContactInfo2D
class	ContactListener
class	ContactListener2D
class	Controller
class	ConvexHullShape
class	ConvexHullShape2D
class	Cubemap
class	CullerComponent
class	CylinderMesh
class	CylinderShape
class	DateTime
class	DebugHandler
class	DirectoryWatcher
class	Drawable
struct	DynamicSetting
	Dynamically updated setting value. More...
class	Engine
class	EnvironmentRecorder
class	FileLoader
class	Font
class	FrustumShape
class	GearJoint
class	GearJoint2D
class	GlState
class	GlStateManager
class	Glyph
class	Image
class	InfinitePlaneShape
class	Joint
class	Joint2D
class	Keyboard
class	LightContainer
	Container for lights. More...
class	LightSource
class	Listener
class	MainRenderTarget
class	Material
class	Mesh
class	Message
class	Model
class	ModelLoader
class	Mouse
class	Object
struct	OrderedRenderPass
	Orderer render pass. More...
class	PhantomBody
class	PistonJoint
class	PistonJoint2D
class	PostProcessor
class	PulleyJoint2D
class	Randomizer
class	RayInfo
class	RayInfo2D
struct	Rect
class	RectangleMesh
class	RectangleShape
class	RectangleShape2D
class	Renderer
class	RenderPass
class	RenderTarget
class	RenderTexture
class	Resource
	Base class for resources. More...
class	ResourceManager
class	RigidBody
class	RigidBody2D
class	RopeJoint
class	RopeJoint2D
class	RotationJoint
class	RotationJoint2D
class	SafeReferenceable
class	Scene
class	Sensor
class	SerializeInfo
class	Serializer
class	SettingCallback
	Base class For a setting change callback. More...
class	SettingManager
class	Shader
class	ShaderAssembler
class	ShaderPreprocessor
class	ShaderProgram
class	SkyBox
class	SkySphere
struct	SortedRenderPass
	Distance-sorted render pass. More...
class	SoundBuffer
class	SoundEffect
class	SoundSource
class	SoundStream
class	SphereMesh
class	SphereShape
class	Sprite
class	Subsystem
class	SubSystem
class	TerrainShape
class	TerrainShape2D
class	Text
class	Texture
class	Texture2D
class	TextureAtlas
class	TextureSampler
class	Thread
class	Touch
class	Transform
class	Vertex
class	VertexBuffer
class	Vibrator
class	VideoInfo
class	WeakReference
class	WeldJoint
class	WeldJoint2D
class	WheelJoint
class	WheelJoint2D
class	Window
class	WindowEventHandler
class	World
class	World2D

Typedefs
typedef std::function< Component &(JOP_COMPONENT_FACTORY_ARGS)>	ComponentFactoryFunc
typedef std::function< bool(JOP_COMPONENT_LOAD_ARGS)>	ComponentLoadFunc
typedef std::function< bool(JOP_COMPONENT_SAVE_ARGS)>	ComponentSaveFunc
typedef std::function< Scene &(JOP_SCENE_FACTORY_ARGS)>	SceneFactoryFunc
typedef std::function< bool(JOP_SCENE_LOAD_ARGS)>	SceneLoadFunc
typedef std::function< bool(JOP_SCENE_SAVE_ARGS)>	SceneSaveFunc
typedef std::function< Resource &(JOP_RESOURCE_FACTORY_ARGS)>	ResourceFactoryFunc
typedef std::function< bool(JOP_RESOURCE_LOAD_ARGS)>	ResourceLoadFunc
typedef std::function< bool(JOP_RESOURCE_SAVE_ARGS)>	ResourceSaveFunc
typedef float	float32
	32 bit float (single-precision) More...
typedef double	float64
	64 bit float (double precision) More...
typedef signed char	int8
	8 bit signed integer More...
typedef signed short	int16
	16 bit signed integer More...
typedef signed int	int32
	32 bit signed integer More...
typedef signed long long	int64
	64 bit signed integer More...
typedef unsigned char	uint8
	8 bit unsigned integer More...
typedef unsigned short	uint16
	16 bit unsigned integer More...
typedef unsigned int	uint32
	32 bit unsigned integer More...
typedef unsigned long long	uint64
	64 bit unsigned integer More...
typedef void *	WindowHandle
typedef WindowHandle	WindowLibHandle

Functions
JOP_API const std::string &	getProjectName ()
	Get the project name. More...
JOP_API Message::Result	broadcast (const Message &message)
	Broadcast a message to the whole engine. More...
JOP_API void	assertion (const bool expression, const std::string &file, unsigned int line, const std::string &message)
	Custom assertion function. More...
template<typename To , typename From >
WeakReference< To >	static_ref_cast (const WeakReference< From > &other)
	Statically cast a weak reference. More...
template<typename To , typename From >
WeakReference< To >	dynamic_ref_cast (const WeakReference< From > &other)
	Dynamically cast a weak reference. More...

Typedef Documentation

typedef std::function<Component&(JOP_COMPONENT_FACTORY_ARGS)> jop::ComponentFactoryFunc

Definition at line 55 of file Serializer.hpp.

typedef std::function<bool(JOP_COMPONENT_LOAD_ARGS)> jop::ComponentLoadFunc

Definition at line 58 of file Serializer.hpp.

typedef std::function<bool(JOP_COMPONENT_SAVE_ARGS)> jop::ComponentSaveFunc

Definition at line 59 of file Serializer.hpp.

typedef float jop::float32

32 bit float (single-precision)

Definition at line 30 of file Types.hpp.

typedef double jop::float64

64 bit float (double precision)

Definition at line 31 of file Types.hpp.

typedef signed short jop::int16

16 bit signed integer

Definition at line 34 of file Types.hpp.

typedef signed int jop::int32

32 bit signed integer

Definition at line 35 of file Types.hpp.

typedef signed long long jop::int64

64 bit signed integer

Definition at line 36 of file Types.hpp.

typedef signed char jop::int8

8 bit signed integer

Definition at line 33 of file Types.hpp.

typedef std::function<Resource&(JOP_RESOURCE_FACTORY_ARGS)> jop::ResourceFactoryFunc

Definition at line 65 of file Serializer.hpp.

typedef std::function<bool(JOP_RESOURCE_LOAD_ARGS)> jop::ResourceLoadFunc

Definition at line 66 of file Serializer.hpp.

typedef std::function<bool(JOP_RESOURCE_SAVE_ARGS)> jop::ResourceSaveFunc

Definition at line 67 of file Serializer.hpp.

typedef std::function<Scene&(JOP_SCENE_FACTORY_ARGS)> jop::SceneFactoryFunc

Definition at line 61 of file Serializer.hpp.

typedef std::function<bool(JOP_SCENE_LOAD_ARGS)> jop::SceneLoadFunc

Definition at line 62 of file Serializer.hpp.

typedef std::function<bool(JOP_SCENE_SAVE_ARGS)> jop::SceneSaveFunc

Definition at line 63 of file Serializer.hpp.

typedef unsigned short jop::uint16

16 bit unsigned integer

Definition at line 39 of file Types.hpp.

typedef unsigned int jop::uint32

32 bit unsigned integer

Definition at line 40 of file Types.hpp.

typedef unsigned long long jop::uint64

64 bit unsigned integer

Definition at line 41 of file Types.hpp.

typedef unsigned char jop::uint8

8 bit unsigned integer

Definition at line 38 of file Types.hpp.

typedef void* jop::WindowHandle

Definition at line 44 of file WindowHandle.hpp.

typedef WindowHandle jop::WindowLibHandle

Definition at line 62 of file WindowHandle.hpp.

Function Documentation

JOP_API void jop::assertion	(	const bool	expression,
		const std::string &	file,
		unsigned int	line,
		const std::string &	message
	)

Custom assertion function.

This function, should the assertion fail, opens a customized message box and exits the program.

Parameters

expression	The expression to be tested
file	File name
line	The line number
message	Description of the error

JOP_API Message::Result jop::broadcast

(

const Message &

message

)

Broadcast a message to the whole engine.

This is the same as calling jop::Engine::sendMessage().

Parameters

message

The message

Returns

The message result

template<typename To , typename From >

WeakReference<To> jop::dynamic_ref_cast

(

const WeakReference< From > &

other

)

Dynamically cast a weak reference.

Parameters

other

The reference to cast

Returns

Weak reference with the cast type. Empty if unsuccessful

JOP_API const std::string& jop::getProjectName

(

)

Get the project name.

Returns

A reference to the internal string containing the project name

template<typename To , typename From >

WeakReference<To> jop::static_ref_cast

(

const WeakReference< From > &

other

)

Statically cast a weak reference.

Parameters

other

The reference to cast

Returns

Weak reference with the cast type