unify(view): Merge View and closely related code (#1904)

Author: xezon

Generals/Code/GameEngine/Include/Common/DrawModule.h

@@ -38,6 +38,7 @@
 // FORWARD REFERENCES /////////////////////////////////////////////////////////////////////////////
 class Matrix3D;
 class RenderCost;
+class OBBoxClass;
 
 // TYPES //////////////////////////////////////////////////////////////////////////////////////////
 
@@ -154,6 +155,10 @@ class ObjectDrawInterface
 
 	// this method must ONLY be called from the client, NEVER From the logic, not even indirectly.
 	virtual Bool clientOnly_getRenderObjInfo(Coord3D* pos, Real* boundingSphereRadius, Matrix3D* transform) const = 0;
+
+	// (gth) C&C3 adding these accessors to render object properties
+	virtual Bool clientOnly_getRenderObjBoundBox(OBBoxClass * boundbox) const = 0;
+	virtual Bool clientOnly_getRenderObjBoneTransform(const AsciiString & boneName,Matrix3D * set_tm) const = 0;
 	/**
 		Find the bone(s) with the given name and return their positions and/or transforms in the given arrays.
 		We look for a bone named "boneNamePrefixQQ", where QQ is 01, 02, 03, etc, starting at the

Generals/Code/GameEngine/Include/GameClient/CommandXlat.h

@@ -76,6 +76,7 @@ enum FilterTypes CPP_11(: Int)
 	FT_VIEW_BW_FILTER,		//filter to apply a black & white filter to the screen.
 	FT_VIEW_MOTION_BLUR_FILTER, //filter to apply motion blur filter to screen.
 	FT_VIEW_CROSSFADE,				///<filter to apply a cross blend between previous/current views.
+	FT_VIEW_DEFAULT,				///<default filter mode for default filter.
 	FT_MAX
 };
 
@@ -101,7 +102,7 @@ enum FilterModes CPP_11(: Int)
 	FM_VIEW_MB_OUT_SATURATE, // Motion blur filter out saturated blur
 	FM_VIEW_MB_END_PAN_ALPHA, // Moton blur on screen pan (for camera tracks object mode)
 
-
+	FM_VIEW_DEFAULT,	//Default filter that's enabled when all others are off.
 
 	// NOTE: This has to be the last entry in this enum.
 	// Add new entries before this one.  jba.

Generals/Code/GameEngine/Include/GameClient/Display.h

@@ -173,6 +173,7 @@ class Display : public SubsystemInterface
 	virtual void toggleLetterBox(void) = 0;										///< enabled letter-boxed display
 	virtual void enableLetterBox(Bool enable) = 0;						///< forces letter-boxed display on/off
 	virtual Bool isLetterBoxFading( void ) { return FALSE; }	///< returns true while letterbox fades in/out
+	virtual Bool isLetterBoxed( void ) { return FALSE; }	//WST 10/2/2002. Added query interface
 
 	virtual void setCinematicText( AsciiString string ) { m_cinematicText = string; }
 	virtual void setCinematicFont( GameFont *font ) { m_cinematicFont = font; }

Generals/Code/GameEngine/Include/GameClient/View.h

@@ -135,19 +135,23 @@ class View : public Snapshot
 	virtual void initHeightForMap( void ) {};														///<  Init the camera height for the map at the current position.
 	virtual void scrollBy( Coord2D *delta );														///< Shift the view by the given delta
 
-	virtual void moveCameraTo(const Coord3D *o, Int frames, Int shutter, Bool orient) { lookAt( o ); }
-	virtual void moveCameraAlongWaypointPath(Waypoint *way, Int frames, Int shutter, Bool orient) { }
+	virtual void moveCameraTo(const Coord3D *o, Int frames, Int shutter, Bool orient, Real easeIn=0.0f, Real easeOut=0.0f) { lookAt( o ); }
+	virtual void moveCameraAlongWaypointPath(Waypoint *way, Int frames, Int shutter, Bool orient, Real easeIn=0.0f, Real easeOut=0.0f) { }
 	virtual Bool isCameraMovementFinished( void ) { return TRUE; }
-	virtual void cameraModFinalZoom(Real finalZoom){};			 ///< Final zoom for current camera movement.
+	virtual void cameraModFinalZoom(Real finalZoom, Real easeIn=0.0f, Real easeOut=0.0f){}; ///< Final zoom for current camera movement.
 	virtual void cameraModRollingAverage(Int framesToAverage){}; ///< Number of frames to average movement for current camera movement.
 	virtual void cameraModFinalTimeMultiplier(Int finalMultiplier){}; ///< Final time multiplier for current camera movement.
-	virtual void cameraModFinalPitch(Real finalPitch){};		 ///< Final pitch for current camera movement.
+	virtual void cameraModFinalPitch(Real finalPitch, Real easeIn=0.0f, Real easeOut=0.0f){};	 ///< Final pitch for current camera movement.
 	virtual void cameraModFreezeTime(void){ }					///< Freezes time during the next camera movement.
 	virtual void cameraModFreezeAngle(void){ }					///< Freezes time during the next camera movement.
 	virtual void cameraModLookToward(Coord3D *pLoc){}			///< Sets a look at point during camera movement.
 	virtual void cameraModFinalLookToward(Coord3D *pLoc){}			///< Sets a look at point during camera movement.
 	virtual void cameraModFinalMoveTo(Coord3D *pLoc){ };			///< Sets a final move to.
 
+	// (gth) C&C3 animation controled camera feature
+	virtual void cameraEnableSlaveMode(const AsciiString & thingtemplateName, const AsciiString & boneName) {}
+	virtual void cameraDisableSlaveMode(void) {}
+	virtual	void Add_Camera_Shake(const Coord3D & position,float radius, float duration, float power) {}
 	virtual FilterModes getViewFilterMode(void) {return (FilterModes)0;}			///< Turns on viewport special effect (black & white mode)
 	virtual FilterTypes getViewFilterType(void) {return (FilterTypes)0;}			///< Turns on viewport special effect (black & white mode)
 	virtual Bool setViewFilterMode(FilterModes filterMode) { return FALSE; }			///< Turns on viewport special effect (black & white mode)
@@ -157,16 +161,16 @@ class View : public Snapshot
 	virtual void setFadeParameters(Int fadeFrames, Int direction) { };
 	virtual void set3DWireFrameMode(Bool enable) { };
 
- 	virtual void resetCamera(const Coord3D *location, Int frames) {}; ///< Move camera to location, and reset to default angle & zoom.
- 	virtual void rotateCamera(Real rotations, Int frames) {}; ///< Rotate camera about current viewpoint.
-	virtual void rotateCameraTowardObject(ObjectID id, Int milliseconds, Int holdMilliseconds) {};	///< Rotate camera to face an object, and hold on it
-	virtual void rotateCameraTowardPosition(const Coord3D *pLoc, Int milliseconds) {};	///< Rotate camera to face a location.
+ 	virtual void resetCamera(const Coord3D *location, Int frames, Real easeIn=0.0f, Real easeOut=0.0f) {}; ///< Move camera to location, and reset to default angle & zoom.
+ 	virtual void rotateCamera(Real rotations, Int frames, Real easeIn=0.0f, Real easeOut=0.0f) {}; ///< Rotate camera about current viewpoint.
+	virtual void rotateCameraTowardObject(ObjectID id, Int milliseconds, Int holdMilliseconds, Real easeIn=0.0f, Real easeOut=0.0f) {};	///< Rotate camera to face an object, and hold on it
+	virtual void rotateCameraTowardPosition(const Coord3D *pLoc, Int milliseconds, Real easeIn=0.0f, Real easeOut=0.0f, Bool reverseRotation=FALSE) {};	///< Rotate camera to face a location.
 	virtual Bool isTimeFrozen(void){ return false;}					///< Freezes time during the next camera movement.
 	virtual Int	 getTimeMultiplier(void) {return 1;};				///< Get the time multiplier.
 	virtual void setTimeMultiplier(Int multiple) {}; ///< Set the time multiplier.
 	virtual void setDefaultView(Real pitch, Real angle, Real maxHeight) {};
-	virtual void zoomCamera( Real finalZoom, Int milliseconds ) {};
-	virtual void pitchCamera( Real finalPitch, Int milliseconds ) {};
+	virtual void zoomCamera( Real finalZoom, Int milliseconds, Real easeIn=0.0f, Real easeOut=0.0f ) {};
+	virtual void pitchCamera( Real finalPitch, Int milliseconds, Real easeIn=0.0f, Real easeOut=0.0f ) {};
 
 	virtual void setAngle( Real angle );																///< Rotate the view around the up axis to the given angle
 	virtual Real getAngle( void ) { return m_angle; }

Generals/Code/GameEngineDevice/Include/W3DDevice/GameClient/Module/W3DModelDraw.h

@@ -363,6 +363,8 @@ class W3DModelDraw : public DrawModule, public ObjectDrawInterface
 
 	// this method must ONLY be called from the client, NEVER From the logic, not even indirectly.
 	virtual Bool clientOnly_getRenderObjInfo(Coord3D* pos, Real* boundingSphereRadius, Matrix3D* transform) const;
+	virtual Bool clientOnly_getRenderObjBoundBox(OBBoxClass * boundbox) const;
+	virtual Bool clientOnly_getRenderObjBoneTransform(const AsciiString & boneName,Matrix3D * set_tm) const;
 	virtual Int getPristineBonePositionsForConditionState(const ModelConditionFlags& condition, const char* boneNamePrefix, Int startIndex, Coord3D* positions, Matrix3D* transforms, Int maxBones) const;
 	virtual Int getCurrentBonePositions(const char* boneNamePrefix, Int startIndex, Coord3D* positions, Matrix3D* transforms, Int maxBones) const;
 	virtual Bool getCurrentWorldspaceClientBonePositions(const char* boneName, Matrix3D& transform) const;

Generals/Code/GameEngineDevice/Include/W3DDevice/GameClient/W3DDisplay.h

@@ -127,6 +127,7 @@ class W3DDisplay : public Display
 	virtual void enableLetterBox(Bool enable);	///<forces letter-boxed display on/off
 
 	virtual Bool isLetterBoxFading(void);	///<returns true while letterbox fades in/out
+	virtual Bool isLetterBoxed(void);
 
 	virtual void clearShroud();
 	virtual void setShroudLevel(Int x, Int y, CellShroudStatus setting);

Generals/Code/GameEngineDevice/Include/W3DDevice/GameClient/W3DView.h

@@ -38,6 +38,7 @@
 
 // USER INCLUDES //////////////////////////////////////////////////////////////////////////////////
 #include "Common/STLTypedefs.h"
+#include "GameClient/ParabolicEase.h"
 #include "GameClient/View.h"
 #include "WW3D2/camera.h"
 
@@ -55,8 +56,6 @@ typedef struct
 	Coord3D	waypoints[MAX_WAYPOINTS+2];		// We pad first & last for interpolation.
 	Real		waySegLength[MAX_WAYPOINTS+2];	// Length of each segment;
 	Real		cameraAngle[MAX_WAYPOINTS+2];	// Camera Angle;
-	Real		cameraFXPitch[MAX_WAYPOINTS+2];	// Camera Pitch;
-	Real		cameraZoom[MAX_WAYPOINTS+2];	// Camera Zoom;
 	Int			timeMultiplier[MAX_WAYPOINTS+2];	// Time speedup factor.
 	Real		groundHeight[MAX_WAYPOINTS+1];	// Ground height.
 	Real		totalTimeMilliseconds;					// Num of ms to do this movement.
@@ -67,6 +66,7 @@ typedef struct
 	Int			curSegment;										// The current segment.
 	Int			curShutter;										// The current shutter.
 	Int			rollingAverageFrames;					// Number of frames to roll.
+	ParabolicEase ease;										// Ease in/out function.
 } TMoveAlongWaypointPathInfo;
 
 // ------------------------------------------------------------------------------------------------
@@ -75,17 +75,23 @@ typedef struct
 {
 	Int			numFrames;						///< Number of frames to rotate.
 	Int			curFrame;							///< Current frame.
-	Real		angle;
-	Real		startZoom;
-	Real		endZoom;
-	Real		startPitch;
-	Real		endPitch;
 	Int			startTimeMultiplier;
 	Int			endTimeMultiplier;
-	ObjectID targetObjectID;			///< Target if we are tracking an object instead of just rotating
-	Coord3D	targetObjectPos;			///< Target's position (so we can stay looking at that spot if he dies)
-	Bool		trackObject;					///< Are we tracking an object or just rotating?
 	Int			numHoldFrames;				///< Number of frames to hold the camera before finishing the movement
+	ParabolicEase ease;
+	Bool		trackObject;					///< Are we tracking an object or just rotating?
+	struct Target {
+		ObjectID targetObjectID;			///< Target if we are tracking an object instead of just rotating
+		Coord3D	targetObjectPos;			///< Target's position (so we can stay looking at that spot if he dies)
+	};
+	struct Angle {
+		Real startAngle;
+		Real endAngle;
+	};
+	union {
+		Target target;
+		Angle angle;
+	};
 } TRotateCameraInfo;
 
 // ------------------------------------------------------------------------------------------------
@@ -99,6 +105,7 @@ typedef struct
 	Real		endPitch;
 	Int			startTimeMultiplier;
 	Int			endTimeMultiplier;
+	ParabolicEase ease;
 } TPitchCameraInfo;
 
 // ------------------------------------------------------------------------------------------------
@@ -111,6 +118,7 @@ typedef struct
 	Real		endZoom;
 	Int			startTimeMultiplier;
 	Int			endTimeMultiplier;
+	ParabolicEase ease;
 } TZoomCameraInfo;
 
 // ------------------------------------------------------------------------------------------------
@@ -155,28 +163,36 @@ class W3DView : public View, public SubsystemInterface
 
 	virtual void lookAt( const Coord3D *o );											///< Center the view on the given coordinate
 	virtual void initHeightForMap( void );												///<  Init the camera height for the map at the current position.
-	virtual void moveCameraTo(const Coord3D *o, Int miliseconds,  Int shutter, Bool orient);
-	virtual void moveCameraAlongWaypointPath(Waypoint *pWay, Int frames, Int shutter, Bool orient);
+	virtual void moveCameraTo(const Coord3D *o, Int miliseconds,  Int shutter, Bool orient, Real easeIn, Real easeOut);
+	virtual void moveCameraAlongWaypointPath(Waypoint *pWay, Int frames, Int shutter, Bool orient, Real easeIn, Real easeOut);
 	virtual Bool isCameraMovementFinished(void);
- 	virtual void resetCamera(const Coord3D *location, Int frames);	///< Move camera to location, and reset to default angle & zoom.
- 	virtual void rotateCamera(Real rotations, Int frames);					///< Rotate camera about current viewpoint.
-	virtual void rotateCameraTowardObject(ObjectID id, Int milliseconds, Int holdMilliseconds);	///< Rotate camera to face an object, and hold on it
-	virtual void rotateCameraTowardPosition(const Coord3D *pLoc, Int milliseconds);	///< Rotate camera to face a location.
+	virtual Bool isCameraMovementAtWaypointAlongPath(void);
+ 	virtual void resetCamera(const Coord3D *location, Int frames, Real easeIn, Real easeOut);	///< Move camera to location, and reset to default angle & zoom.
+ 	virtual void rotateCamera(Real rotations, Int frames, Real easeIn, Real easeOut);					///< Rotate camera about current viewpoint.
+	virtual void rotateCameraTowardObject(ObjectID id, Int milliseconds, Int holdMilliseconds, Real easeIn, Real easeOut);	///< Rotate camera to face an object, and hold on it
+	virtual void rotateCameraTowardPosition(const Coord3D *pLoc, Int milliseconds, Real easeIn, Real easeOut, Bool reverseRotation);	///< Rotate camera to face a location.
 	virtual void cameraModFreezeTime(void){ m_freezeTimeForCameraMovement = true;}					///< Freezes time during the next camera movement.
 	virtual void cameraModFreezeAngle(void);												///< Freezes time during the next camera movement.
 	virtual Bool isTimeFrozen(void){ return m_freezeTimeForCameraMovement;}					///< Freezes time during the next camera movement.
-	virtual void cameraModFinalZoom(Real finalZoom);								///< Final zoom for current camera movement.
+	virtual void cameraModFinalZoom(Real finalZoom, Real easeIn, Real easeOut);	///< Final zoom for current camera movement.
 	virtual void cameraModRollingAverage(Int framesToAverage);			///< Number of frames to average movement for current camera movement.
 	virtual void cameraModFinalTimeMultiplier(Int finalMultiplier); ///< Final time multiplier for current camera movement.
-	virtual void cameraModFinalPitch(Real finalPitch);							///< Final pitch for current camera movement.
+	virtual void cameraModFinalPitch(Real finalPitch, Real easeIn, Real easeOut);	///< Final pitch for current camera movement.
 	virtual void cameraModLookToward(Coord3D *pLoc);								///< Sets a look at point during camera movement.
 	virtual void cameraModFinalLookToward(Coord3D *pLoc);						///< Sets a look at point during camera movement.
 	virtual void cameraModFinalMoveTo(Coord3D *pLoc);			///< Sets a final move to.
+	// (gth) C&C3 animation controlled camera feature
+	virtual void cameraEnableSlaveMode(const AsciiString & thingtemplateName, const AsciiString & boneName);
+	virtual void cameraDisableSlaveMode(void);
+	virtual void cameraEnableRealZoomMode(void); //WST 10.18.2002
+	virtual void cameraDisableRealZoomMode(void);
+
+	virtual	void Add_Camera_Shake(const Coord3D & position,float radius, float duration, float power); //WST 10.18.2002
 	virtual Int	 getTimeMultiplier(void) {return m_timeMultiplier;};///< Get the time multiplier.
 	virtual void setTimeMultiplier(Int multiple) {m_timeMultiplier = multiple;}; ///< Set the time multiplier.
 	virtual void setDefaultView(Real pitch, Real angle, Real maxHeight);
-	virtual void zoomCamera( Real finalZoom, Int milliseconds );
-	virtual void pitchCamera( Real finalPitch, Int milliseconds );
+	virtual void zoomCamera( Real finalZoom, Int milliseconds, Real easeIn, Real easeOut );
+	virtual void pitchCamera( Real finalPitch, Int milliseconds, Real easeIn, Real easeOut );
 
 	virtual void setHeightAboveGround(Real z);
 	virtual void setZoom(Real z);
@@ -229,7 +245,7 @@ class W3DView : public View, public SubsystemInterface
 	Real m_shakeAngleCos;														///< the cosine of the orientation of the oscillation
 	Real m_shakeAngleSin;														///< the sine of the orientation of the oscillation
 	Real m_shakeIntensity;													///< the intensity of the oscillation
-
+	Vector3 m_shakerAngles;													//WST 11/12/2002 new multiple instance camera shaker system
 
 	TRotateCameraInfo	m_rcInfo;
 	Bool		m_doingRotateCamera;										///< True if we are doing a camera rotate.
@@ -244,7 +260,8 @@ class W3DView : public View, public SubsystemInterface
 	Real		m_FXPitch;															///< Camera effects pitch.  0 = flat, infinite = look down, 1 = normal.
 
 	TMoveAlongWaypointPathInfo m_mcwpInfo;					///< Move camera along waypoint path info.
-	Bool		m_doingMoveCameraOnWaypointPath;				///< If true, moving camera along waypoint path.
+	Bool	m_doingMoveCameraOnWaypointPath;				///< If true, moving camera along waypoint path.
+	Bool	m_CameraArrivedAtWaypointOnPathFlag;
 
 	Bool		m_freezeTimeForCameraMovement;
 	Int			m_timeMultiplier;												///< Time speedup multiplier.
@@ -274,6 +291,11 @@ class W3DView : public View, public SubsystemInterface
 	void getAxisAlignedViewRegion(Region3D &axisAlignedRegion);	///< Find 3D Region enclosing all possible drawables.
 	void calcDeltaScroll(Coord2D &screenDelta);
 
+	// (gth) C&C3 animation controlled camera feature
+	Bool				m_isCameraSlaved;
+	Bool				m_useRealZoomCam;
+	AsciiString		m_cameraSlaveObjectName;
+	AsciiString		m_cameraSlaveObjectBoneName;
 };
 
 // EXTERNALS //////////////////////////////////////////////////////////////////////////////////////

Generals/Code/GameEngineDevice/Source/W3DDevice/GameClient/Drawable/Draw/W3DModelDraw.cpp

@@ -3458,6 +3458,48 @@ Int W3DModelDraw::getPristineBonePositionsForConditionState(
 	return posCount;
 }
 
+
+//-------------------------------------------------------------------------------------------------
+// (gth) C&C3 Added this accessor for the bounding box of a render object in a W3DModelDraw module
+// this method must ONLY be called from the client, NEVER From the logic, not even indirectly.
+Bool W3DModelDraw::clientOnly_getRenderObjBoundBox(OBBoxClass * boundbox) const
+{
+	if (!m_renderObject)
+		return false;
+
+	AABoxClass aabox;
+	m_renderObject->Get_Obj_Space_Bounding_Box(aabox);
+
+	Matrix3D tm = m_renderObject->Get_Transform();
+
+	// build an OBB for this AAB,transform
+	OBBoxClass box0(aabox.Center,aabox.Extent);
+	OBBoxClass::Transform(tm,box0,boundbox);
+
+	return true;
+}
+
+
+//-------------------------------------------------------------------------------------------------
+// (gth) C&C3 Added this accessor for a bone transform in the render object
+// this method must ONLY be called from the client, NEVER From the logic, not even indirectly.
+Bool W3DModelDraw::clientOnly_getRenderObjBoneTransform(const AsciiString & boneName,Matrix3D * set_tm) const
+{
+	if (!m_renderObject) {
+		return false;
+	}
+
+	int idx = m_renderObject->Get_Bone_Index(boneName.str());
+	if (idx == 0) {
+		set_tm->Make_Identity();
+		return false;
+	} else {
+		*set_tm = m_renderObject->Get_Bone_Transform(idx);
+		return true;
+	}
+}
+
+
 //-------------------------------------------------------------------------------------------------
 Bool W3DModelDraw::getCurrentWorldspaceClientBonePositions(const char* boneName, Matrix3D& transform) const
 {

Generals/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DDisplay.cpp

@@ -1940,6 +1940,12 @@ Bool W3DDisplay::isLetterBoxFading(void)
 	return FALSE;
 }
 
+//WST 10/2/2002 added query function.  JSC Integrated 5/20/03
+Bool W3DDisplay::isLetterBoxed(void)
+{
+	return (m_letterBoxEnabled);
+}
+
 // W3DDisplay::createLightPulse ===============================================
 /** Create a "light pulse" which is a dynamic light that grows, decays
 	* and vanishes over several frames */