/** 
 * @file llviewerjoint.cpp
 * @brief Implementation of LLViewerJoint class
 *
 * Copyright (c) 2001-2007, Linden Research, Inc.
 * 
 * Second Life Viewer Source Code
 * The source code in this file ("Source Code") is provided by Linden Lab
 * to you under the terms of the GNU General Public License, version 2.0
 * ("GPL"), unless you have obtained a separate licensing agreement
 * ("Other License"), formally executed by you and Linden Lab.  Terms of
 * the GPL can be found in doc/GPL-license.txt in this distribution, or
 * online at http://secondlife.com/developers/opensource/gplv2
 * 
 * There are special exceptions to the terms and conditions of the GPL as
 * it is applied to this Source Code. View the full text of the exception
 * in the file doc/FLOSS-exception.txt in this software distribution, or
 * online at http://secondlife.com/developers/opensource/flossexception
 * 
 * By copying, modifying or distributing this software, you acknowledge
 * that you have read and understood your obligations described above,
 * and agree to abide by those obligations.
 * 
 * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
 * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
 * COMPLETENESS OR PERFORMANCE.
 */

//-----------------------------------------------------------------------------
// Header Files
//-----------------------------------------------------------------------------
#include "llviewerprecompiledheaders.h"

#include "llviewerjoint.h"

#include "llgl.h"
#include "llmath.h"
#include "llglheaders.h"
#include "llsphere.h"
#include "llvoavatar.h"
#include "pipeline.h"

#define DEFAULT_LOD 0.0f

const S32 MIN_PIXEL_AREA_3PASS_HAIR = 64*64;

//-----------------------------------------------------------------------------
// Static Data
//-----------------------------------------------------------------------------
BOOL					LLViewerJoint::sDisableLOD = FALSE;

//-----------------------------------------------------------------------------
// LLViewerJoint()
// Class Constructor
//-----------------------------------------------------------------------------
LLViewerJoint::LLViewerJoint()
{
	mUpdateXform = TRUE;
	mValid = FALSE;
	mComponents = SC_JOINT | SC_BONE | SC_AXES;
	mMinPixelArea = DEFAULT_LOD;
	mPickName = PN_DEFAULT;
	mVisible = TRUE;
}


//-----------------------------------------------------------------------------
// LLViewerJoint()
// Class Constructor
//-----------------------------------------------------------------------------
LLViewerJoint::LLViewerJoint(const std::string &name, LLJoint *parent) :
	LLJoint(name, parent)
{
	mValid = FALSE;
	mComponents = SC_JOINT | SC_BONE | SC_AXES;
	mMinPixelArea = DEFAULT_LOD;
	mPickName = PN_DEFAULT;
}


//-----------------------------------------------------------------------------
// ~LLViewerJoint()
// Class Destructor
//-----------------------------------------------------------------------------
LLViewerJoint::~LLViewerJoint()
{
}


//--------------------------------------------------------------------
// setValid()
//--------------------------------------------------------------------
void LLViewerJoint::setValid( BOOL valid, BOOL recursive )
{
	//----------------------------------------------------------------
	// set visibility for this joint
	//----------------------------------------------------------------
	mValid = valid;
	
	//----------------------------------------------------------------
	// set visibility for children
	//----------------------------------------------------------------
	if (recursive)
	{
		for (child_list_t::iterator iter = mChildren.begin();
			 iter != mChildren.end(); ++iter)
		{
			LLViewerJoint* joint = (LLViewerJoint*)(*iter);
			joint->setValid(valid, TRUE);
		}
	}

}

//--------------------------------------------------------------------
// renderSkeleton()
//--------------------------------------------------------------------
void LLViewerJoint::renderSkeleton(BOOL recursive)
{
	F32 nc = 0.57735f;

	//----------------------------------------------------------------
	// push matrix stack
	//----------------------------------------------------------------
	glPushMatrix();

	//----------------------------------------------------------------
	// render the bone to my parent
	//----------------------------------------------------------------
	if (mComponents & SC_BONE)
	{
		drawBone();
	}

	//----------------------------------------------------------------
	// offset to joint position and 
	// rotate to our orientation
	//----------------------------------------------------------------
	glLoadIdentity();
	glMultMatrixf( &getWorldMatrix().mMatrix[0][0] );

	//----------------------------------------------------------------
	// render joint axes
	//----------------------------------------------------------------
	if (mComponents & SC_AXES)
	{
		glBegin(GL_LINES);
		glColor3f( 1.0f, 0.0f, 0.0f );
		glVertex3f( 0.0f,            0.0f, 0.0f );
		glVertex3f( 0.1f, 0.0f, 0.0f );

		glColor3f( 0.0f, 1.0f, 0.0f );
		glVertex3f( 0.0f, 0.0f,            0.0f );
		glVertex3f( 0.0f, 0.1f, 0.0f );

		glColor3f( 0.0f, 0.0f, 1.0f );
		glVertex3f( 0.0f, 0.0f, 0.0f );
		glVertex3f( 0.0f, 0.0f, 0.1f );
		glEnd();
	}

	//----------------------------------------------------------------
	// render the joint graphic
	//----------------------------------------------------------------
	if (mComponents & SC_JOINT)
	{
		glColor3f( 1.0f, 1.0f, 0.0f );

		glBegin(GL_TRIANGLES);

		// joint top half
		glNormal3f(nc, nc, nc);
		glVertex3f(0.0f,             0.0f, 0.05f);
		glVertex3f(0.05f,       0.0f,       0.0f);
		glVertex3f(0.0f,       0.05f,       0.0f);

		glNormal3f(-nc, nc, nc);
		glVertex3f(0.0f,             0.0f, 0.05f);
		glVertex3f(0.0f,       0.05f,       0.0f);
		glVertex3f(-0.05f,      0.0f,       0.0f);
		
		glNormal3f(-nc, -nc, nc);
		glVertex3f(0.0f,             0.0f, 0.05f);
		glVertex3f(-0.05f,      0.0f,      0.0f);
		glVertex3f(0.0f,      -0.05f,      0.0f);

		glNormal3f(nc, -nc, nc);
		glVertex3f(0.0f,              0.0f, 0.05f);
		glVertex3f(0.0f,       -0.05f,       0.0f);
		glVertex3f(0.05f,        0.0f,       0.0f);
		
		// joint bottom half
		glNormal3f(nc, nc, -nc);
		glVertex3f(0.0f,             0.0f, -0.05f);
		glVertex3f(0.0f,       0.05f,        0.0f);
		glVertex3f(0.05f,       0.0f,        0.0f);

		glNormal3f(-nc, nc, -nc);
		glVertex3f(0.0f,             0.0f, -0.05f);
		glVertex3f(-0.05f,      0.0f,        0.0f);
		glVertex3f(0.0f,       0.05f,        0.0f);
		
		glNormal3f(-nc, -nc, -nc);
		glVertex3f(0.0f,              0.0f, -0.05f);
		glVertex3f(0.0f,       -0.05f,        0.0f);
		glVertex3f(-0.05f,       0.0f,        0.0f);

		glNormal3f(nc, -nc, -nc);
		glVertex3f(0.0f,             0.0f,  -0.05f);
		glVertex3f(0.05f,       0.0f,         0.0f);
		glVertex3f(0.0f,      -0.05f,         0.0f);
		
		glEnd();
	}

	//----------------------------------------------------------------
	// render children
	//----------------------------------------------------------------
	if (recursive)
	{
		for (child_list_t::iterator iter = mChildren.begin();
			 iter != mChildren.end(); ++iter)
		{
			LLViewerJoint* joint = (LLViewerJoint*)(*iter);
			joint->renderSkeleton();
		}
	}

	//----------------------------------------------------------------
	// pop matrix stack
	//----------------------------------------------------------------
	glPopMatrix();
}


//--------------------------------------------------------------------
// render()
//--------------------------------------------------------------------
U32 LLViewerJoint::render( F32 pixelArea, BOOL first_pass )
{
	U32 triangle_count = 0;

	//----------------------------------------------------------------
	// ignore invisible objects
	//----------------------------------------------------------------
	if ( mValid )
	{


		//----------------------------------------------------------------
		// if object is transparent, defer it, otherwise
		// give the joint subclass a chance to draw itself
		//----------------------------------------------------------------
		if ( gRenderForSelect )
		{
			triangle_count += drawShape( pixelArea, first_pass );
		}
		else if ( isTransparent() )
		{
			// Hair and Skirt
			if ((pixelArea > MIN_PIXEL_AREA_3PASS_HAIR))
			{
				// render all three passes
				LLGLDisable cull(GL_CULL_FACE);
				// first pass renders without writing to the z buffer
				{
					LLGLDepthTest gls_depth(GL_TRUE, GL_FALSE);
					triangle_count += drawShape( pixelArea, first_pass);
				}
				// second pass writes to z buffer only
				glColorMask(FALSE, FALSE, FALSE, FALSE);
				{
					triangle_count += drawShape( pixelArea, FALSE );
				}
				// third past respects z buffer and writes color
				glColorMask(TRUE, TRUE, TRUE, FALSE);
				{
					LLGLDepthTest gls_depth(GL_TRUE, GL_FALSE);
					triangle_count += drawShape( pixelArea, FALSE );
				}
			}
			else
			{
				// Render Inside (no Z buffer write)
				glCullFace(GL_FRONT);
				{
					LLGLDepthTest gls_depth(GL_TRUE, GL_FALSE);
					triangle_count += drawShape( pixelArea, first_pass );
				}
				// Render Outside (write to the Z buffer)
				glCullFace(GL_BACK);
				{
					triangle_count += drawShape( pixelArea, FALSE );
				}
			}
		}
		else
		{
			// set up render state
			triangle_count += drawShape( pixelArea, first_pass );
		}
	}

	//----------------------------------------------------------------
	// render children
	//----------------------------------------------------------------
	for (child_list_t::iterator iter = mChildren.begin();
		 iter != mChildren.end(); ++iter)
	{
		LLViewerJoint* joint = (LLViewerJoint*)(*iter);
		F32 jointLOD = joint->getLOD();
		if (pixelArea >= jointLOD || sDisableLOD)
		{
			triangle_count += joint->render( pixelArea );

			if (jointLOD != DEFAULT_LOD)
			{
				break;
			}
		}
	}

	return triangle_count;
}


//--------------------------------------------------------------------
// drawBone()
//--------------------------------------------------------------------
void LLViewerJoint::drawBone()
{
	if ( mParent == NULL )
		return;

	F32 boneSize = 0.02f;

	// rotate to point to child (bone direction)
	glPushMatrix();

	LLVector3 boneX = getPosition();
	F32 length = boneX.normVec();

	LLVector3 boneZ(1.0f, 0.0f, 1.0f);
	
	LLVector3 boneY = boneZ % boneX;
	boneY.normVec();

	boneZ = boneX % boneY;

	LLMatrix4 rotateMat;
	rotateMat.setFwdRow( boneX );
	rotateMat.setLeftRow( boneY );
	rotateMat.setUpRow( boneZ );
	glMultMatrixf( &rotateMat.mMatrix[0][0] );

	// render the bone
	glColor3f( 0.5f, 0.5f, 0.0f );

	glBegin(GL_TRIANGLES);

	glVertex3f( length,     0.0f,       0.0f);
	glVertex3f( 0.0f,       boneSize,  0.0f);
	glVertex3f( 0.0f,       0.0f,       boneSize);

	glVertex3f( length,     0.0f,        0.0f);
	glVertex3f( 0.0f,       0.0f,        -boneSize);
	glVertex3f( 0.0f,       boneSize,   0.0f);

	glVertex3f( length,     0.0f,        0.0f);
	glVertex3f( 0.0f,       -boneSize,  0.0f);
	glVertex3f( 0.0f,       0.0f,        -boneSize);

	glVertex3f( length,     0.0f,        0.0f);
	glVertex3f( 0.0f,       0.0f,        boneSize);
	glVertex3f( 0.0f,       -boneSize,  0.0f);

	glEnd();

	// restore matrix
	glPopMatrix();
}

//--------------------------------------------------------------------
// isTransparent()
//--------------------------------------------------------------------
BOOL LLViewerJoint::isTransparent()
{
	return FALSE;
}

//--------------------------------------------------------------------
// drawShape()
//--------------------------------------------------------------------
U32 LLViewerJoint::drawShape( F32 pixelArea, BOOL first_pass )
{
	return 0;
}

//--------------------------------------------------------------------
// setSkeletonComponents()
//--------------------------------------------------------------------
void LLViewerJoint::setSkeletonComponents( U32 comp, BOOL recursive )
{
	mComponents = comp;
	if (recursive)
	{
		for (child_list_t::iterator iter = mChildren.begin();
			 iter != mChildren.end(); ++iter)
		{
			LLViewerJoint* joint = (LLViewerJoint*)(*iter);
			joint->setSkeletonComponents(comp, recursive);
		}
	}
}

void LLViewerJoint::updateFaceSizes(U32 &num_vertices, U32& num_indices, F32 pixel_area)
{
	for (child_list_t::iterator iter = mChildren.begin();
		 iter != mChildren.end(); ++iter)
	{
		LLViewerJoint* joint = (LLViewerJoint*)(*iter);
		//F32 jointLOD = joint->getLOD();
		//if (pixel_area >= jointLOD || sDisableLOD)
		{
			joint->updateFaceSizes(num_vertices, num_indices, pixel_area);

		//	if (jointLOD != DEFAULT_LOD)
		//	{
		//		break;
		//	}
		}
	}
}

void LLViewerJoint::updateFaceData(LLFace *face, F32 pixel_area, BOOL damp_wind)
{
	for (child_list_t::iterator iter = mChildren.begin();
		 iter != mChildren.end(); ++iter)
	{
		LLViewerJoint* joint = (LLViewerJoint*)(*iter);
		//F32 jointLOD = joint->getLOD();
		//if (pixel_area >= jointLOD || sDisableLOD)
		{
			joint->updateFaceData(face, pixel_area, damp_wind);

		//	if (jointLOD != DEFAULT_LOD)
		//	{
		//		break;
		//	}
		}
	}
}

void LLViewerJoint::updateGeometry()
{
	for (child_list_t::iterator iter = mChildren.begin();
		 iter != mChildren.end(); ++iter)
	{
		LLViewerJoint* joint = (LLViewerJoint*)(*iter);
		joint->updateGeometry();
	}
}


BOOL LLViewerJoint::updateLOD(F32 pixel_area, BOOL activate)
{
	BOOL lod_changed = FALSE;
	BOOL found_lod = FALSE;

	for (child_list_t::iterator iter = mChildren.begin();
		 iter != mChildren.end(); ++iter)
	{
		LLViewerJoint* joint = (LLViewerJoint*)(*iter);
		F32 jointLOD = joint->getLOD();
		
		if (found_lod || jointLOD == DEFAULT_LOD)
		{
			// we've already found a joint to enable, so enable the rest as alternatives
			lod_changed |= joint->updateLOD(pixel_area, TRUE);
		}
		else
		{
			if (pixel_area >= jointLOD || sDisableLOD)
			{
				lod_changed |= joint->updateLOD(pixel_area, TRUE);
				found_lod = TRUE;
			}
			else
			{
				lod_changed |= joint->updateLOD(pixel_area, FALSE);
			}
		}
	}
	return lod_changed;
}

void LLViewerJoint::dump()
{
	for (child_list_t::iterator iter = mChildren.begin();
		 iter != mChildren.end(); ++iter)
	{
		LLViewerJoint* joint = (LLViewerJoint*)(*iter);
		joint->dump();
	}
}

void LLViewerJoint::setVisible(BOOL visible, BOOL recursive)
{
	mVisible = visible;

	if (recursive)
	{
		for (child_list_t::iterator iter = mChildren.begin();
			 iter != mChildren.end(); ++iter)
		{
			LLViewerJoint* joint = (LLViewerJoint*)(*iter);
			joint->setVisible(visible, recursive);
		}
	}
}

void LLViewerJoint::writeCAL3D(apr_file_t* fp)
{
	LLVector3 bone_pos = mXform.getPosition();
	if (mParent)
	{
		bone_pos.scaleVec(mParent->getScale());
		bone_pos *= 100.f;
	}
	else
	{
		bone_pos.clearVec();
	}
	
	LLQuaternion bone_rot;

	S32 num_children = 0;
	for (child_list_t::iterator iter = mChildren.begin();
		 iter != mChildren.end(); ++iter)
	{
		LLViewerJoint* joint = (LLViewerJoint*)(*iter);
		if (joint->mJointNum != -1)
		{
			num_children++;
		}
	}

	LLJoint* cur_joint = this;
	LLVector3 rootSkinOffset;
	if (mParent)
	{
		while (cur_joint)
		{
			rootSkinOffset -= cur_joint->getSkinOffset();
			cur_joint = (LLViewerJoint*)cur_joint->getParent();
		}

		rootSkinOffset *= 100.f;
	}

	apr_file_printf(fp, "	<BONE ID=\"%d\" NAME=\"%s\" NUMCHILDS=\"%d\">\n", mJointNum + 1, mName.c_str(), num_children);
	apr_file_printf(fp, "		<TRANSLATION>%.6f %.6f %.6f</TRANSLATION>\n", bone_pos.mV[VX], bone_pos.mV[VY], bone_pos.mV[VZ]);
	apr_file_printf(fp, "		<ROTATION>%.6f %.6f %.6f %.6f</ROTATION>\n", bone_rot.mQ[VX], bone_rot.mQ[VY], bone_rot.mQ[VZ], bone_rot.mQ[VW]);
	apr_file_printf(fp, "		<LOCALTRANSLATION>%.6f %.6f %.6f</LOCALTRANSLATION>\n", rootSkinOffset.mV[VX], rootSkinOffset.mV[VY], rootSkinOffset.mV[VZ]);
	apr_file_printf(fp, "		<LOCALROTATION>0 0 0 1</LOCALROTATION>\n");
	apr_file_printf(fp, "		<PARENTID>%d</PARENTID>\n", mParent ? mParent->mJointNum + 1 : -1);
	
	for (child_list_t::iterator iter = mChildren.begin();
		 iter != mChildren.end(); ++iter)
	{
		LLViewerJoint* joint = (LLViewerJoint*)(*iter);
		if (joint->mJointNum != -1)
		{
			apr_file_printf(fp, "		<CHILDID>%d</CHILDID>\n", joint->mJointNum + 1);
		}
	}
	apr_file_printf(fp, "	</BONE>\n");

	// recurse
	for (child_list_t::iterator iter = mChildren.begin();
		 iter != mChildren.end(); ++iter)
	{
		LLViewerJoint* joint = (LLViewerJoint*)(*iter);
		if (joint->mJointNum != -1)
		{
			joint->writeCAL3D(fp);
		}
	}

}

//-----------------------------------------------------------------------------
// LLViewerJointCollisionVolume()
//-----------------------------------------------------------------------------

LLViewerJointCollisionVolume::LLViewerJointCollisionVolume()
{
	mUpdateXform = FALSE;
}

LLViewerJointCollisionVolume::LLViewerJointCollisionVolume(const std::string &name, LLJoint *parent) : LLViewerJoint(name, parent)
{
	
}

void LLViewerJointCollisionVolume::render()
{
	updateWorldMatrix();
	glMatrixMode(GL_MODELVIEW);
	glPushMatrix();
	glMultMatrixf( &mXform.getWorldMatrix().mMatrix[0][0] );

	glColor3f( 0.f, 0.f, 1.f );
	gSphere.render();

	glPopMatrix();
}

LLVector3 LLViewerJointCollisionVolume::getVolumePos(LLVector3 &offset)
{
	mUpdateXform = TRUE;
	
	LLVector3 result = offset;
	result.scaleVec(getScale());
	result.rotVec(getWorldRotation());
	result += getWorldPosition();

	return result;
}

// End