ef2gamesource/dlls/game/bspline.cpp

//-----------------------------------------------------------------------------
//
//  $Logfile:: /EF2/Code/DLLs/game/bspline.cpp                               $
// $Revision:: 12                                                             $
//   $Author:: Singlis                                                        $
//     $Date:: 9/26/03 2:35p                                                  $
//
// Copyright (C) 1998 by Ritual Entertainment, Inc.
// All rights reserved.
//
// This source is may not be distributed and/or modified without
// expressly written permission by Ritual Entertainment, Inc.
//
// DESCRIPTION:
// Uniform non-rational bspline class.
//

#include "_pch_cpp.h"
#include "bspline.h"

void BSpline::Set( const Vector *control_points_, int num_control_points_, splinetype_t type )
{
	int i;
	
	SetType( type );
	
	has_orientation = false;
	
	if ( control_points )
	{
		delete [] control_points;
		control_points = NULL;
	}
	
	num_control_points = num_control_points_;
	if ( num_control_points )
	{
		control_points = new BSplineControlPoint[ num_control_points ];
		assert( control_points );
		
		for( i = 0; i < num_control_points; i++ )
		{
			control_points[ i ].Set( control_points_[ i ] );
		}
	}
}

void BSpline::Set( const Vector *control_points_, const Vector *control_orients_, const float  *control_speeds_,
		int num_control_points_, splinetype_t type )
{
	int i;
	
	SetType( type );
	
	has_orientation = true;
	
	if ( control_points )
	{
		delete [] control_points;
		control_points = NULL;
	}
	
	num_control_points = num_control_points_;
	if ( num_control_points )
	{
		control_points = new BSplineControlPoint[ num_control_points ];
		assert( control_points );
		
		for( i = 0; i < num_control_points; i++ )
		{
			control_points[ i ].Set( control_points_[ i ], control_orients_[ i ], control_speeds_[ i ] );
		}
	}
}

void BSpline::Clear( void )
{
	if( control_points )
	{
		delete [] control_points;
		control_points = NULL;
	}
	num_control_points = 0;
	has_orientation = false;
}

inline float BSpline::EvalNormal( float u, Vector& pos, Vector& orient )
{
	int		segment_id;
	float		B[ 4 ];
	float		tmp;
	float		u_2;
	float		u_3;
	Vector   ang;
	float    roll;
	float    speed;
	
	segment_id = ( int )u;
	if ( segment_id < 0 )
	{
		segment_id = 0;
	}
	if ( segment_id > ( num_control_points - 4 ) )
	{
		segment_id = num_control_points - 4;
	}
	u -= ( float )segment_id;
	
	u_2 = u * u;
	u_3 = u * u_2;
	
	tmp = 1.0f - u;
	B[ 0 ] = ( tmp * tmp * tmp ) * ( 1.0f / 6.0f );
	B[ 1 ] = ( ( 3.0f * u_3 ) - ( 6.0f * u_2 ) + 4.0f ) * ( 1.0f / 6.0f );
	B[ 2 ] = ( ( -3.0f * u_3 ) + ( 3.0f * u_2 ) + ( 3.0f * u ) + 1 ) * ( 1.0f / 6.0f );
	B[ 3 ] = u_3 * ( 1.0f / 6.0f );
	
	pos =
		( *control_points[ 0 + segment_id ].GetPosition() * B[ 0 ] ) +
		( *control_points[ 1 + segment_id ].GetPosition() * B[ 1 ] ) +
		( *control_points[ 2 + segment_id ].GetPosition() * B[ 2 ] ) +
		( *control_points[ 3 + segment_id ].GetPosition() * B[ 3 ] );
	
	ang =
		( *control_points[ 0 + segment_id ].GetOrientation() * B[ 0 ] ) +
		( *control_points[ 1 + segment_id ].GetOrientation() * B[ 1 ] ) +
		( *control_points[ 2 + segment_id ].GetOrientation() * B[ 2 ] ) +
		( *control_points[ 3 + segment_id ].GetOrientation() * B[ 3 ] );
	
	roll =
		( *control_points[ 0 + segment_id ].GetRoll() * B[ 0 ] ) +
		( *control_points[ 1 + segment_id ].GetRoll() * B[ 1 ] ) +
		( *control_points[ 2 + segment_id ].GetRoll() * B[ 2 ] ) +
		( *control_points[ 3 + segment_id ].GetRoll() * B[ 3 ] );
	
	speed =
		( *control_points[ 0 + segment_id ].GetSpeed() * B[ 0 ] ) +
		( *control_points[ 1 + segment_id ].GetSpeed() * B[ 1 ] ) +
		( *control_points[ 2 + segment_id ].GetSpeed() * B[ 2 ] ) +
		( *control_points[ 3 + segment_id ].GetSpeed() * B[ 3 ] );
	
	orient = ang.toAngles();
	orient[ ROLL ] = roll;
	
	return speed;
}

inline float BSpline::EvalLoop( float t, Vector& pos, Vector& orient )
{
	Vector	retval;
	Vector   ang;
	float    speed;
	float    roll;
	int		segment_id;
	int      next_id;
	float		B[ 4 ];
	float		tmp;
	float		u;
	float		u_2;
	float		u_3;
	int		i;
	int		j;
	
	segment_id = ( int )floor( t );
	u = t - floor( t );
	
	segment_id %= num_control_points;
	if ( segment_id < 0 )
	{
		segment_id += num_control_points;
	}
	
	u_2 = u * u;
	u_3 = u * u_2;
	
	tmp = 1.0f - u;
	B[ 0 ] = ( tmp * tmp * tmp ) * ( 1.0f / 6.0f );
	B[ 1 ] = ( ( 3.0f * u_3 ) - ( 6.0f * u_2 ) + 4.0f ) * ( 1.0f / 6.0f );
	B[ 2 ] = ( ( -3.0f * u_3 ) + ( 3.0f * u_2 ) + ( 3.0f * u ) + 1 ) * ( 1.0f / 6.0f );
	B[ 3 ] = u_3 * ( 1.0f / 6.0f );
	
	speed = 0;
	roll = 0;
	
	for( i = 0, j = segment_id; i < 4; i++, j++ )
	{
		if ( j >= num_control_points )
		{
			j -= ( num_control_points - loop_control_point );
		}
		
		retval += *control_points[ j ].GetPosition() * B[ i ];
		ang += *control_points[ j ].GetOrientation() * B[ i ];
		speed += *control_points[ j ].GetSpeed() * B[ i ];
		roll += *control_points[ j ].GetRoll() * B[ i ];
	}
	
	pos = retval;
	
	next_id = segment_id + 1;
	if ( next_id >= num_control_points )
	{
		next_id -= ( num_control_points - loop_control_point );
	}
	orient = ang.toAngles();
	orient[ ROLL ] = roll;
	
	return speed;
}

inline float BSpline::EvalClamp( float t, Vector& pos, Vector& orient )
{
	Vector	retval;
	Vector   ang;
	int		segment_id;
	int		next_id;
	float		B[ 4 ];
	float		tmp;
	float		u;
	float		u_2;
	float		u_3;
	int		i;
	int		j;
	float    speed;
	float    roll;
	
	segment_id = ( int )floor( t );
	u = t - floor( t );
	
	u_2 = u * u;
	u_3 = u * u_2;
	
	tmp = 1.0f - u;
	B[ 0 ] = ( tmp * tmp * tmp ) * ( 1.0f / 6.0f );
	B[ 1 ] = ( ( 3.0f * u_3 ) - ( 6.0f * u_2 ) + 4.0f ) * ( 1.0f / 6.0f );
	B[ 2 ] = ( ( -3.0f * u_3 ) + ( 3.0f * u_2 ) + ( 3.0f * u ) + 1 ) * ( 1.0f / 6.0f );
	B[ 3 ] = u_3 * ( 1.0f / 6.0f );
	
	speed = 0.0f;
	roll = 0.0f;
	for( i = 0; i < 4; i++, segment_id++ )
	{
		j = segment_id;
		if ( j < 0 )
		{
			j = 0;
		}
		else if ( j >= num_control_points )
		{
			j = num_control_points - 1;
		}
		
		retval += *control_points[ j ].GetPosition() * B[ i ];
		ang += *control_points[ j ].GetOrientation() * B[ i ];
		speed += *control_points[ j ].GetSpeed() * B[ i ];
		roll += *control_points[ j ].GetRoll() * B[ i ];
	}
	
	pos = retval;
	
	next_id = segment_id + 1;
	if ( segment_id < 0 )
	{
		segment_id = 0;
	}
	if ( segment_id >= num_control_points )
	{
		segment_id = num_control_points - 1;
	}
	if ( next_id < 0 )
	{
		next_id = 0;
	}
	if ( next_id >= num_control_points )
	{
		next_id = num_control_points - 1;
	}
	orient = ang.toAngles();
	orient[ ROLL ] = roll;
	
	return speed;
}


Vector BSpline::Eval( float u )
{
	Vector pos;
	Vector orient;
	
	switch( curvetype )
	{
	default:
	case SPLINE_NORMAL :
		EvalNormal( u, pos, orient );
		break;
		
	case SPLINE_CLAMP:
		EvalClamp( u, pos, orient );
		break;
		
	case SPLINE_LOOP:
		if ( u < 0.0f )
		{
            EvalClamp( u, pos, orient );
		}
		else
		{
            EvalLoop( u, pos, orient );
		}
		break;
	}
	return pos;
}

float BSpline::Eval( float u, Vector &pos, Vector &orient )
{
	switch( curvetype )
	{
	default:
	case SPLINE_NORMAL :
		return EvalNormal( u, pos, orient );
		break;
		
	case SPLINE_CLAMP:
		return EvalClamp( u, pos, orient );
		break;
		
	case SPLINE_LOOP:
		if ( u < 0.0f )
		{
            return EvalClamp( u, pos, orient );
		}
		else
		{
            return EvalLoop( u, pos, orient );
		}
		break;
	}
}

void BSpline::DrawControlSegments( void )
{
	int i;
	
	G_BeginLine();
	for( i = 0; i < num_control_points; i++ )
	{
		G_Vertex( *control_points[ i ].GetPosition() );
	}
	G_EndLine();
}

void BSpline::DrawCurve( int num_subdivisions )
{
	float u;
	float du;
	
	if ( !num_control_points )
	{
		return;
	}
	
	du = 1.0f / ( float )num_subdivisions;
	
	G_BeginLine();
	for( u = -2.0f; u <= ( float )num_control_points; u += du )
	{
		G_Vertex( ( Vector )Eval( u ) );
	}
	G_EndLine();
}

void BSpline::DrawCurve( const Vector &offset, int num_subdivisions )
{
	float u;
	float du;
	
	du = 1.0f / ( float )num_subdivisions;
	
	G_BeginLine();
	for( u = -2.0f; u <= ( float )num_control_points; u += du )
	{
		G_Vertex( offset + ( Vector )Eval( u ) );
	}
	G_EndLine();
}

void BSpline::AppendControlPoint( const Vector& new_control_point )
{
	BSplineControlPoint *old_control_points;
	int i;
	
	old_control_points = control_points;
	num_control_points++;
	
	control_points = new BSplineControlPoint[num_control_points];
	assert( control_points );
	
	if ( old_control_points )
	{
		for( i = 0; i < ( num_control_points - 1 ) ; i++ )
		{
			control_points[ i ] = old_control_points[ i ];
		}
		delete [] old_control_points;
	}
	
	control_points[ num_control_points - 1 ].Set( new_control_point );
}

void BSpline::AppendControlPoint( const Vector& new_control_point, const float& speed )
{
	BSplineControlPoint *old_control_points;
	int i;
	
	old_control_points = control_points;
	num_control_points++;
	
	control_points = new BSplineControlPoint[num_control_points];
	assert( control_points );
	
	if ( old_control_points )
	{
		for( i = 0; i < ( num_control_points - 1 ); i++ )
		{
			control_points[ i ] = old_control_points[ i ];
		}
		delete [] old_control_points;
	}
	
	control_points[ num_control_points - 1 ].Set( new_control_point, speed );
}

void BSpline::AppendControlPoint( const Vector& new_control_point, const Vector& new_control_orient,
	const float& new_control_speed )
{
	BSplineControlPoint *old_control_points;
	int i;
	
	has_orientation = true;
	
	old_control_points = control_points;
	num_control_points++;
	
	control_points = new BSplineControlPoint[num_control_points];
	assert( control_points );
	
	if ( old_control_points )
	{
		for( i = 0; i < ( num_control_points - 1 ) ; i++ )
		{
			control_points[ i ] = old_control_points[ i ];
		}
		delete [] old_control_points;
	}
	
	control_points[ num_control_points - 1 ].Set( new_control_point, new_control_orient, new_control_speed );
}

void BSpline::SetLoopPoint( const Vector& pos )
{
	int i;
	
	for( i = 0; i < num_control_points; i++ )
	{
		if ( pos == *control_points[ i ].GetPosition() )
		{
			loop_control_point = i;
			break;
		}
	}
}

int BSpline::PickControlPoint( const Vector& window_point, float pick_size )
{
	int	i;
	float closest_dist_2;
	int	closest_index;
	float dist_2;
	Vector delta;
	
	closest_index = -1;
	closest_dist_2 = 1000000.0f;
	for( i = 0; i < num_control_points; i++ )
	{
		delta = window_point - *control_points[ i ].GetPosition();
		dist_2 = delta * delta;
		if ( dist_2 < closest_dist_2 )
		{
			closest_dist_2 = dist_2;
			closest_index = i;
		}
	}
	
	if ( pick_size * pick_size >= closest_dist_2 )
	{
		return closest_index;
	}
	else
	{
		return -1;
	}
}

Event EV_SplinePath_Create
(
	"SplinePath_create",
	EV_SCRIPTONLY,
	NULL,
	NULL,
	"Creates the spline path from the target list."
);
Event EV_SplinePath_Loop
(
	"loopSpline",
	EV_SCRIPTONLY,
	"s",
	"loop_name",
	"Sets the loop name."
);
Event EV_SplinePath_Speed
(
	"speed",
	EV_DEFAULT,
	"f",
	"speed",
	"Sets the path speed."
);
Event EV_SplinePath_SetTriggerTarget
(
	"triggertarget",
	EV_SCRIPTONLY,
	"s",
	"target",
	"Sets the trigger target."
);
Event EV_SplinePath_SetThread
(
	"thread",
	EV_SCRIPTONLY,
	"s",
	"thread",
	"Sets the thread."
);
Event EV_SplinePath_SetWatch
(
	"watch",
	EV_SCRIPTONLY,
	"s",
	"watchEntity",
	"Sets the entity to watch at this node."
);
Event EV_SplinePath_SetFov
(
	"fov",
	EV_CONSOLE,
	"f",
	"cameraFOV",
	"Sets the fov at this node."
);
Event EV_SplinePath_SetFadeTime
(
	"fadetime",
	EV_SCRIPTONLY,
	"f",
	"fadeTime",
	"Sets the fadetime at this node."
);
Event EV_SplinePath_MoveSpline
(
	"movespline",
	EV_SCRIPTONLY,
	"v",
	"new_position",
	"Sets the new position of the spline."
);
Event EV_SplinePath_OffsetSpline
(
	"offsetspline",
	EV_SCRIPTONLY,
	"v",
	"offset",
	"Offsets the position of the spline."
);
Event EV_SplinePath_TurnSpline
(
	"turnspline",
	EV_SCRIPTONLY,
	"v",
	"angle_offset",
	"Turns the spline."
);

/*QUAKED info_splinepath (0 0 .5) (-8 -8 -8) (8 8 8) x x x x x x x LADYBUG
Spline Path Node
"angles" camera will use that orientation
"loop" set a loop node
"triggertarget" when node is reached fire these targets
"thread" fire this thread when node is reached
"speed" speed multiplier for this segment, normally each\
segment will take 1 second to traverse, use 2 for double speed\
and 0.5 for half speed
*/

CLASS_DECLARATION( Entity, SplinePath, "info_splinepath" )
{
	{ &EV_SplinePath_Create,					&SplinePath::CreatePath },
	{ &EV_SplinePath_Loop,						&SplinePath::SetLoop },
	{ &EV_SplinePath_Speed,						&SplinePath::SetSpeed },
	{ &EV_SplinePath_SetTriggerTarget,			&SplinePath::SetTriggerTarget },
	{ &EV_SplinePath_SetThread,					&SplinePath::SetThread },
	{ &EV_SplinePath_SetWatch,					&SplinePath::SetWatch },
	{ &EV_SplinePath_SetFov,					&SplinePath::SetFov },
	{ &EV_SplinePath_SetFadeTime,				&SplinePath::SetFadeTime },
	{ &EV_SplinePath_MoveSpline,				&SplinePath::MoveSpline },
	{ &EV_SplinePath_OffsetSpline,				&SplinePath::OffsetSpline },
	{ &EV_SplinePath_TurnSpline,				&SplinePath::TurnSpline },

	{ NULL, NULL }
};

SplinePath::SplinePath()
{
	owner = this;
	next = NULL;
	loop = NULL;
	speed = 1;
	doWatch = false;
	watchEnt = "";
	fov = 0;
	fadeTime = -1;
	
	setMoveType( MOVETYPE_NONE );
	setSolidType( SOLID_NOT );
	hideModel();
	
	if ( !LoadingSavegame )
	{
		PostEvent( EV_SplinePath_Create, FRAMETIME );
	}
}

SplinePath::~SplinePath()
{
	// disconnect from the chain
	if ( owner != this )
	{
		owner->SetNext( next );
	}
	else if ( next )
	{
		next->SetPrev( NULL );
		next = NULL;
	}
	
	assert( owner == this );
	assert( next == NULL );
}

void SplinePath::SetLoop( Event *ev )
{
	loop_name = ev->GetString( 1 );
}

void SplinePath::SetSpeed( Event *ev )
{
	speed = ev->GetFloat( 1 );
}

void SplinePath::SetTriggerTarget( Event *ev )
{
	SetTriggerTarget( ev->GetString( 1 ) );
}

void SplinePath::SetThread( Event *ev )
{
	SetThread( ev->GetString( 1 ) );
}

void SplinePath::CreatePath( Event * )
{
	const char  *target;
	Entity      *ent;
	
	// Make the path from the targetlist.
	target = Target();
	if ( target[ 0 ] )
	{
		ent = G_FindTarget( NULL, target );
		if ( ent )
		{
			assert( next == NULL );

			next = ( SplinePath * )ent;
			next->owner = this;
		}
		else
		{
			gi.Error( ERR_DROP, "SplinePath::CreatePath: target %s not found\n", target );
		}
	}
	if ( loop_name.length() )
	{
		ent = G_FindTarget( NULL, loop_name.c_str() );
		if ( ent )
		{
			loop = ( SplinePath * )ent;
		}
	}
}

SplinePath *SplinePath::GetNext( void )
{
	return next;
}

SplinePath *SplinePath::GetPrev( void )
{
	if ( owner == this )
	{
		return NULL;
	}
	
	return owner;
}

void SplinePath::SetNext( SplinePath *node )
{
	if ( next )
	{
		// remove ourselves from the chain
		next->owner = next;
	}
	
	next = node;
	if ( next )
	{
		// disconnect next from it's previous node
		if ( next->owner != next )
		{
			next->owner->next = NULL;
		}
		next->owner = this;
	}
}

void SplinePath::SetPrev( SplinePath *node )
{
	if ( owner != this )
	{
		owner->next = NULL;
	}
	
	if ( node && ( node != this ) )
	{
		// safely remove the node from its chain
		if ( node->next )
		{
			node->next->owner = node->next;
		}
		node->next = this;
		owner = node;
	}
	else
	{
		owner = this;
	}
}

SplinePath *SplinePath::GetLoop( void )
{
	return loop;
}

void SplinePath::SetWatch( const char *name )
{
	if ( watchEnt != name )
	{
		watchEnt = name;
		if ( watchEnt.length() )
		{
			doWatch = true;
		}
		else
		{
			doWatch = false;
		}
	}
}

void SplinePath::SetWatch( Event *ev )
{
	SetWatch( ev->GetString( 1 ) );
}

void SplinePath::NoWatch( void )
{
	doWatch = true;
	watchEnt = "none";
}

str SplinePath::GetWatch( void )
{
	return watchEnt;
}

void SplinePath::SetFov( float newFov )
{
	fov = newFov;
}

void SplinePath::SetFov( Event *ev )
{
	fov = ev->GetFloat( 1 );
}

float SplinePath::GetFov( void )
{
	return fov;
}

void SplinePath::SetFadeTime( float newFadeTime )
{
	fadeTime = newFadeTime;
}

void SplinePath::SetFadeTime( Event *ev )
{
	fadeTime = ev->GetFloat( 1 );
}

float SplinePath::GetFadeTime( void )
{
	return fadeTime;
}

void SplinePath::MoveSpline( Event *ev )
{
	Vector new_position;
	Vector offset;
	Event *new_event;
	
	// Get the new position for this spline node
	
	new_position = ev->GetVector( 1 );
	
	// Get the offset to move the entire spline
	
	offset = new_position - origin;
	
	// Move the entire spline
	
	new_event = new Event( EV_SplinePath_OffsetSpline );
	
	new_event->AddVector( offset );
	
	ProcessEvent( new_event );
}

void SplinePath::OffsetSpline( Event *ev )
{
	Vector offset;
	const char  *target;
	Entity      *ent;
	
	offset = ev->GetVector( 1 );
	
	target = Target();
	
	setOrigin( origin + offset );
	
	if ( !target || !target[ 0 ] )
		return;
	
	ent = G_FindTarget( NULL, target );
	
	if ( !ent )
		return;
	
	while ( ent && ( ent != this ) )
	{
		ent->setOrigin( ent->origin + offset );
		
		target = ent->Target();
		
		if ( !target || !target[ 0 ] )
			break;
		
		ent = G_FindTarget( NULL, target );
	}
}

void SplinePath::TurnSpline( Event *ev )
{
	Vector new_angles;
	Vector angles_diff;
	float axis[3][3];
	const char  *target;
	Entity      *ent;
	Vector offset;
	Vector transformed_origin;
	
	new_angles = ev->GetVector( 1 );
	
	angles_diff = new_angles - angles;
	
	AnglesToAxis( angles_diff, axis );
	
	setAngles( new_angles );
	
	target = Target();
	
	if ( !target || !target[ 0 ] )
		return;
	
	ent = G_FindTarget( NULL, target );
	
	if ( !ent )
		return;
	
	while ( ent && ( ent != this ) )
	{
		offset = ent->origin - origin;
		
		MatrixTransformVector( offset, axis, transformed_origin );
		
		transformed_origin += origin;
		
		ent->setOrigin( transformed_origin );
		
		target = ent->Target();
		
		if ( !target || !target[ 0 ] )
			break;
		
		ent = G_FindTarget( NULL, target );
	}
}