phoenix-firestorm/indra/newview/aoset.cpp

/**
 * @file aoset.cpp
 * @brief Implementation of an Animation Overrider set of animations
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2011, Zi Ree @ Second Life
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * $/LicenseInfo$
 */

#include "llviewerprecompiledheaders.h"

#include "aoengine.h"
#include "aoset.h"
#include "llanimationstates.h"

AOSet::AOSet(const LLUUID inventoryID)
:	LLEventTimer(10000.0f),
	mInventoryID(inventoryID),
	mName("** New AO Set **"),
	mSitOverride(FALSE),
	mSmart(FALSE),
	mMouselookDisable(FALSE),
	mComplete(FALSE),
	mDirty(FALSE),
	mCurrentMotion(LLUUID())
{
	LL_DEBUGS("AOEngine") << "Creating new AO set: " << this << LL_ENDL;

	// ZHAO names first, alternate names following, separated by | characters
	// keep number and order in sync with the enum in the declaration
	const std::string stateNames[AOSTATES_MAX]=
	{
		"Standing|Stand.1|Stand.2|Stand.3",
		"Walking|Walk.N",
		"Running",
		"Sitting|Sit.N",
		"Sitting On Ground|Sit.G",
		"Crouching|Crouch",
		"Crouch Walking|Walk.C",
		"Landing|Land.N",
		"Soft Landing",
		"Standing Up|Stand.U",
		"Falling",
		"Flying Down|Hover.D",
		"Flying Up|Hover.U",
		"Flying|Fly.N",
		"Flying Slow",
		"Hovering|Hover.N",
		"Jumping|Jump.N",
		"Pre Jumping|Jump.P",
		"Turning Right|Turn.R",
		"Turning Left|Turn.L",
		"Typing",
		"Floating|Swim.H",
		"Swimming Forward|Swim.N",
		"Swimming Up|Swim.U",
		"Swimming Down|Swim.D"
	};

	// keep number and order in sync with the enum in the declaration
	const LLUUID stateUUIDs[AOSTATES_MAX]=
	{
		ANIM_AGENT_STAND,
		ANIM_AGENT_WALK,
		ANIM_AGENT_RUN,
		ANIM_AGENT_SIT,
		ANIM_AGENT_SIT_GROUND_CONSTRAINED,
		ANIM_AGENT_CROUCH,
		ANIM_AGENT_CROUCHWALK,
		ANIM_AGENT_LAND,
		ANIM_AGENT_MEDIUM_LAND,
		ANIM_AGENT_STANDUP,
		ANIM_AGENT_FALLDOWN,
		ANIM_AGENT_HOVER_DOWN,
		ANIM_AGENT_HOVER_UP,
		ANIM_AGENT_FLY,
		ANIM_AGENT_FLYSLOW,
		ANIM_AGENT_HOVER,
		ANIM_AGENT_JUMP,
		ANIM_AGENT_PRE_JUMP,
		ANIM_AGENT_TURNRIGHT,
		ANIM_AGENT_TURNLEFT,
		ANIM_AGENT_TYPE,
		ANIM_AGENT_HOVER,		// needs special treatment
		ANIM_AGENT_FLY,			// needs special treatment
		ANIM_AGENT_HOVER_UP,	// needs special treatment
		ANIM_AGENT_HOVER_DOWN	// needs special treatment
	};

	for (S32 index = 0; index < AOSTATES_MAX; ++index)
	{
		std::vector<std::string> stateNameList;
		LLStringUtil::getTokens(stateNames[index], stateNameList, "|");

		mStates[index].mName = stateNameList[0];			// for quick reference
		mStates[index].mAlternateNames = stateNameList;		// to get all possible names, including mName
		mStates[index].mRemapID = stateUUIDs[index];
		mStates[index].mInventoryUUID = LLUUID::null;
		mStates[index].mCurrentAnimation = 0;
		mStates[index].mCurrentAnimationID = LLUUID::null;
		mStates[index].mCycle = FALSE;
		mStates[index].mRandom = FALSE;
		mStates[index].mCycleTime = 0.0f;
		mStates[index].mDirty = FALSE;
		mStateNames.push_back(stateNameList[0]);
	}
	stopTimer();
}

AOSet::~AOSet()
{
	LL_DEBUGS("AOEngine") << "Set deleted: " << this << LL_ENDL;
}

AOSet::AOState* AOSet::getState(S32 eName)
{
	return &mStates[eName];
}

AOSet::AOState* AOSet::getStateByName(const std::string& name)
{
	for (S32 index = 0; index < AOSTATES_MAX; ++index)
	{
		AOState* state = &mStates[index];
		for (U32 names = 0; names < state->mAlternateNames.size(); ++names)
		{
			if (state->mAlternateNames[names].compare(name) == 0)
			{
				return state;
			}
		}
	}
	return NULL;
}

AOSet::AOState* AOSet::getStateByRemapID(const LLUUID& id)
{
	LLUUID remap_id = id;
	if (remap_id == ANIM_AGENT_SIT_GROUND)
	{
		remap_id = ANIM_AGENT_SIT_GROUND_CONSTRAINED;
	}

	for (S32 index = 0; index < AOSTATES_MAX; ++index)
	{
		if (mStates[index].mRemapID == remap_id)
		{
			return &mStates[index];
		}
	}
	return NULL;
}

const LLUUID& AOSet::getAnimationForState(AOState* state) const
{
	if (state)
	{
		S32 numOfAnimations = state->mAnimations.size();
		if (numOfAnimations)
		{
			if (state->mCycle)
			{
				if (state->mRandom)
				{
					state->mCurrentAnimation = ll_frand() * numOfAnimations;
					LL_DEBUGS("AOEngine") << "randomly chosen " << state->mCurrentAnimation << " of " << numOfAnimations << LL_ENDL;
				}
				else
				{
					state->mCurrentAnimation++;
					if (state->mCurrentAnimation >= state->mAnimations.size())
					{
						state->mCurrentAnimation = 0;
					}
					LL_DEBUGS("AOEngine") << "cycle " << state->mCurrentAnimation << " of " << numOfAnimations << LL_ENDL;
				}
			}
			return state->mAnimations[state->mCurrentAnimation].mAssetUUID;
		}
		else
		{
			LL_DEBUGS("AOEngine") << "animation state has no animations assigned" << LL_ENDL;
		}
	}
	return LLUUID::null;
}

void AOSet::startTimer(F32 timeout)
{
	mEventTimer.stop();
	mPeriod = timeout;
	mEventTimer.start();
	LL_DEBUGS("AOEngine") << "Starting state timer for " << getName() << " at " << timeout << LL_ENDL;
}

void AOSet::stopTimer()
{
	LL_DEBUGS("AOEngine") << "State timer for " << getName() << " stopped." << LL_ENDL;
	mEventTimer.stop();
}

BOOL AOSet::tick()
{
	AOEngine::instance().cycleTimeout(this);
	return FALSE;
}

const LLUUID& AOSet::getInventoryUUID() const
{
	return mInventoryID;
}

void AOSet::setInventoryUUID(const LLUUID& inventoryID)
{
	mInventoryID = inventoryID;
}

const std::string& AOSet::getName() const
{
	return mName;
}

void AOSet::setName(const std::string& name)
{
	mName=name;
}

BOOL AOSet::getSitOverride() const
{
	return mSitOverride;
}

void AOSet::setSitOverride(BOOL yes)
{
	mSitOverride = yes;
}

BOOL AOSet::getSmart() const
{
	return mSmart;
}

void AOSet::setSmart(BOOL yes)
{
	mSmart = yes;
}

BOOL AOSet::getMouselookDisable() const
{
	return mMouselookDisable;
}

void AOSet::setMouselookDisable(BOOL yes)
{
	mMouselookDisable = yes;
}

BOOL AOSet::getComplete() const
{
	return mComplete;
}

void AOSet::setComplete(BOOL yes)
{
	mComplete = yes;
}

BOOL AOSet::getDirty() const
{
	return mDirty;
}

void AOSet::setDirty(BOOL yes)
{
	mDirty = yes;
}

void AOSet::setMotion(const LLUUID& motion)
{
	mCurrentMotion = motion;
}

const LLUUID& AOSet::getMotion() const
{
	return mCurrentMotion;
}