Leviathan::BaseConstraint Class Reference

#include <Constraints.h>

Inheritance diagram for Leviathan::BaseConstraint:

Public Member Functions
DLLEXPORT	BaseConstraint (ENTITY_CONSTRAINT_TYPE type, GameWorld *world, Constraintable &first, Constraintable &second)
DLLEXPORT	BaseConstraint (ENTITY_CONSTRAINT_TYPE type, GameWorld *world, Constraintable &first, Constraintable &second, int id)
	Variant for forcing id. More...
virtual DLLEXPORT	~BaseConstraint ()
virtual DLLEXPORT bool	Init ()
	Actually creates the Newton joint. More...
DLLEXPORT void	Release ()
	Calls the Newton destroy function. More...
DLLEXPORT void	Destroy (Constraintable *skipthis=nullptr)
	Call to destroy this constraint. More...
DLLEXPORT ENTITY_CONSTRAINT_TYPE	GetType () const
DLLEXPORT Constraintable &	GetFirstEntity () const
	Gets the first object. More...
DLLEXPORT Constraintable &	GetSecondEntity () const
	Gets the second object. More...
DLLEXPORT int	GetID () const
	Returns ID. More...
Public Member Functions inherited from Leviathan::ThreadSafeGeneric< MutexType >
DLLEXPORT	ThreadSafeGeneric ()
DLLEXPORT	~ThreadSafeGeneric ()
FORCE_INLINE void	VerifyLock (RecursiveLock &guard) const
FORCE_INLINE void	VerifyLock (Lock &lockit) const

Protected Member Functions
virtual DLLEXPORT bool	_CheckParameters ()
virtual DLLEXPORT bool	_CreateActualJoint ()

Protected Attributes
Constraintable &	FirstObject
Constraintable &	SecondObject
int	ID
	Server and client matching identifier for deleting constraints. More...
GameWorld *	OwningWorld
NewtonJoint *	Joint
ENTITY_CONSTRAINT_TYPE	Type
	Constraint type used by serializers to identify the type. More...
Protected Attributes inherited from Leviathan::ThreadSafeGeneric< MutexType >
MutexType	ObjectsLock

Detailed Description

Base class for all different types of constraints to inherit

Todo:

Make this actually ThreadSafe

Definition at line 42 of file Constraints.h.

Constructor & Destructor Documentation

BaseConstraint() [1/2]

DLLEXPORT BaseConstraint::BaseConstraint	(	ENTITY_CONSTRAINT_TYPE	type,
		GameWorld *	world,
		Constraintable &	first,
		Constraintable &	second
	)

Definition at line 9 of file Constraints.cpp.

                                                                     : 
    FirstObject(first), SecondObject(second), ID(IDFactory::GetID()),
    OwningWorld(world), Joint(NULL), Type(type)

{
    
}

BaseConstraint() [2/2]

DLLEXPORT BaseConstraint::BaseConstraint	(	ENTITY_CONSTRAINT_TYPE	type,
		GameWorld *	world,
		Constraintable &	first,
		Constraintable &	second,
		int	id
	)

Variant for forcing id.

Used for receiving from network

Definition at line 18 of file Constraints.cpp.

                                                           :
    FirstObject(first), SecondObject(second), ID(id),
    OwningWorld(world), Joint(NULL), Type(type)
{

}

~BaseConstraint()

DLLEXPORT BaseConstraint::~BaseConstraint ( )

virtual

Definition at line 26 of file Constraints.cpp.

                                         {

}

Member Function Documentation

_CheckParameters()

DLLEXPORT bool BaseConstraint::_CheckParameters ( )

protectedvirtual

Reimplemented in Leviathan::SliderConstraint.

Definition at line 62 of file Constraints.cpp.

                                               {

    return false;
}

_CreateActualJoint()

DLLEXPORT bool BaseConstraint::_CreateActualJoint ( )

protectedvirtual

Reimplemented in Leviathan::SliderConstraint.

Definition at line 67 of file Constraints.cpp.

                                                 {

    return false;
}

Destroy()

DLLEXPORT void BaseConstraint::Destroy

(

Constraintable *

skipthis = nullptr

)

Call to destroy this constraint.

Parameters

skipthis

Skips removing from this side, avoid unlinking multiple times from one side when it is being destructed

Definition at line 52 of file Constraints.cpp.

                                                                {
    
    DEBUG_BREAK;
}

GetFirstEntity()

DLLEXPORT Constraintable & BaseConstraint::GetFirstEntity

(

)

const

Gets the first object.

Definition at line 72 of file Constraints.cpp.

                                                              {
    return FirstObject;
}

GetID()

DLLEXPORT int BaseConstraint::GetID

(

)

const

Returns ID.

Definition at line 57 of file Constraints.cpp.

                                         {

    return ID;
}

GetSecondEntity()

DLLEXPORT Constraintable & BaseConstraint::GetSecondEntity

(

)

const

Gets the second object.

Definition at line 76 of file Constraints.cpp.

                                                               {
    return SecondObject;
}

GetType()

DLLEXPORT ENTITY_CONSTRAINT_TYPE Leviathan::BaseConstraint::GetType ( ) const

inline

Definition at line 72 of file Constraints.h.

                                                               {
            return Type;
        }

Init()

DLLEXPORT bool BaseConstraint::Init ( )

virtual

Actually creates the Newton joint.

The Constraint won't work without calling this

Precondition

The SetParameters method of the child class is called

Todo:

Allow the error messages to be silenced

Definition at line 30 of file Constraints.cpp.

                                   {
    // We use the virtual functions to make the child class handle this //
    if(!_CheckParameters()){

        Logger::Get()->Error("BaseContraint: invalid parameters");
        return false;
    }
    
    if(!_CreateActualJoint()){

        Logger::Get()->Error("BaseContraint: failed to create actual joint");
        return false;
    }

    return true;
}

Release()

DLLEXPORT void BaseConstraint::Release

(

)

Calls the Newton destroy function.

Definition at line 47 of file Constraints.cpp.

                                      {

    Destroy(nullptr);
}

Member Data Documentation

FirstObject

Constraintable& Leviathan::BaseConstraint::FirstObject

protected

Definition at line 91 of file Constraints.h.

ID

int Leviathan::BaseConstraint::ID

protected

Server and client matching identifier for deleting constraints.

Definition at line 95 of file Constraints.h.

Joint

NewtonJoint* Leviathan::BaseConstraint::Joint

protected

Definition at line 100 of file Constraints.h.

OwningWorld

GameWorld* Leviathan::BaseConstraint::OwningWorld

protected

Note

World is a direct ptr since all joints MUST be destroyed before the world is released

Definition at line 99 of file Constraints.h.

SecondObject

Constraintable& Leviathan::BaseConstraint::SecondObject

protected

Definition at line 92 of file Constraints.h.

Type

ENTITY_CONSTRAINT_TYPE Leviathan::BaseConstraint::Type

protected

Constraint type used by serializers to identify the type.

Definition at line 103 of file Constraints.h.

---

The documentation for this class was generated from the following files:

• Constraints.h
• Constraints.cpp