PhysicsEntity.h

/*
 * Copyright (c) 2016-2022 Vera Visions LLC.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
 
var bool autocvar_phys_developer = false;
var float autocvar_phys_pushscale = 1.0f;
var float autocvar_phys_impactforcescale = 1.0f;
var bool autocvar_phys_lowspec = true;
var float autocvar_phys_spinScale = 1.0f;
var float autocvar_phys_forceScale = 1.0f;
 
#ifdef CLIENT
bool physics_supported(void)
{
    return true;
}
#endif
 
#define CG_PHYSICS_LOG          imageToConsole("gfx/icon16/hourglass", ICN_SIZE, "Client Physics Log")
#define SV_PHYSICS_LOG          imageToConsole("gfx/icon16/hourglass", ICN_SIZE, "Server Physics Log")
 
void
_LogPhysics(string msg)
{
#ifdef CLIENT
    if (autocvar_g_logTimestamps)
        print(sprintf("%s ^9%f ^7%s\n", CG_PHYSICS_LOG, time, msg));
    else
        print(sprintf("%s ^7%s\n", CG_PHYSICS_LOG, msg));
#endif
#ifdef SERVER
    if (autocvar_g_logTimestamps)
        print(sprintf("%s ^9%f ^7%s\n", SV_PHYSICS_LOG, time, msg));
    else
        print(sprintf("%s ^7%s\n", SV_PHYSICS_LOG, msg));
#endif
}
 
#define LogPhysics(...) if (autocvar_phys_developer > 0) _ncLog(sprintf(__VA_ARGS__))
 
 
#ifdef CLIENT
var bool autocvar_r_showPhysicsInfo = false;
#endif
 
.float damp_linear;
.float damp_angular;
.float jointgroup;
 
 
enumflags
{
    BPHY_NODMGPUSH,
    BPHY_SHARP
};
 
 
typedef enumflags
{
    PHYENT_CHANGED_ORIGIN_X,
    PHYENT_CHANGED_ORIGIN_Y,
    PHYENT_CHANGED_ORIGIN_Z,
    PHYENT_CHANGED_ANGLES_X,
    PHYENT_CHANGED_ANGLES_Y,
    PHYENT_CHANGED_ANGLES_Z,
    PHYENT_CHANGED_MODELINDEX,
    PHYENT_CHANGED_SIZE,
    PHYENT_CHANGED_FLAGS,
    PHYENT_CHANGED_SOLID,
    PHYENT_CHANGED_FRAME,
    PHYENT_CHANGED_SKIN,
    PHYENT_CHANGED_MOVETYPE,
    PHYENT_CHANGED_EFFECTS,
    PHYENT_CHANGED_BODY,
    PHYENT_CHANGED_SCALE,
    PHYENT_CHANGED_VELOCITY,
    PHYENT_CHANGED_RENDERCOLOR,
    PHYENT_CHANGED_RENDERAMT,
    PHYENT_CHANGED_RENDERMODE,
} nsphyricsentity_changed_t;
 


enum
{
    PHYSM_BOX, 
    PHYSM_SPHERE,   
    PHYSM_CAPSULE, 
    PHYSM_TRIMESH, 
    PHYSM_CYLINDER    
};

class ncPhysicsEntity:ncSurfacePropEntity
{
public:
    void ncPhysicsEntity(void);
 
    /* overrides */
    virtual void Respawn(void);
    virtual void SpawnKey(string,string);
    virtual void SetModel(string);
 
#ifdef SERVER
    virtual void Spawned(void);
    virtual void Pain(entity, entity, int, vector, vector, int);
    virtual void Death(entity, entity, int, vector, vector, int);
    virtual void EvaluateEntity(void);
    virtual float SendEntity(entity,float);
    virtual void Save(float);
    virtual void Restore(string,string);
    virtual void Touch(entity);
#endif
 
#ifdef CLIENT
    virtual void ReceiveEntity(float,float);
    virtual void postdraw(void);
#endif
 
    nonvirtual void _UpdateBuoyancy(void);
    nonvirtual void _UpdateMass(void);

    nonvirtual void SetFriction(float);
    nonvirtual float GetFriction(void);

    nonvirtual float CalculateImpactDamage(int,int);
 
    /* this merely mirrors the GMod API: https://wiki.facepunch.com/gmod/PhysObj */
    nonvirtual vector AlignAngles(vector, vector);
    nonvirtual void ApplyForceCenter(vector);
    nonvirtual void ApplyForceOffset(vector,vector);
    nonvirtual void ApplyTorqueCenter(vector);
    nonvirtual void EnableDrag(bool);
    nonvirtual void EnableGravity(bool);
    nonvirtual void EnableMotion(bool);
    nonvirtual float GetLinearDamping(void);
    nonvirtual float GetAngularDamping(void);
    nonvirtual float GetEnergy(void);
    nonvirtual float GetInertia(void);
    nonvirtual float GetInvInertia(void);
    nonvirtual float GetInvMass(void);
    nonvirtual float GetMass(void);
    nonvirtual vector GetMassCenter(void);
    nonvirtual float GetRotDamping(void);
    nonvirtual float GetSpeedDamping(void);
    nonvirtual float GetSurfaceArea(void);
    nonvirtual float GetVolume(void);
    nonvirtual bool IsAsleep(void);
    nonvirtual bool IsCollisionEnabled(void);
    nonvirtual bool IsDragEnabled(void);
    nonvirtual bool IsGravityEnabled(void);
    nonvirtual bool IsMotionEnabled(void);
    nonvirtual bool IsMoveable(void);
    nonvirtual bool IsPenetrating(void);

    nonvirtual void SetAngleDragCoefficient(float);
    nonvirtual void SetBuoyancyRatio(float);
    nonvirtual void SetDamping(float, float);
    nonvirtual void SetDragCoefficient(float);

    nonvirtual void SetInertia(float);
    nonvirtual void SetMass(float);

    nonvirtual void Wake(void);
    nonvirtual void Sleep(void);
 
private:
    int m_physicsEnabled;
    int m_desiredGeomtype;
    int m_surfdataID;
    int m_physicsFlags;
    float m_inertiaScale;
    float m_buoyancyRatio;
    bool m_physicsGod;
    float m_overrideVolume;
    float m_lastTouchTime;
 
    NETWORKED_FLOAT(m_overrideMass)
 
    /* performance sanity checks */
    vector m_lastValidSimPos;
    vector m_lastvalidSimAng;
    float m_timeSincePhysicsCheck;
    float m_spawnPhysTime;
    bool m_playingFeedbackSound;
 
    vector m_massCenter;
 
#ifdef SERVER
    string m_outputOnDamaged;
    bool m_pvsSleep;
    nonvirtual void PVSCheck(void);
#endif
};
 
noref .bool isPhysics;
 // end of pmove