RenderableEntity.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.
*/
 
typedef enumflags
{
    RDENT_CHANGED_ORIGIN_X,
    RDENT_CHANGED_ORIGIN_Y,
    RDENT_CHANGED_ORIGIN_Z,
    RDENT_CHANGED_ANGLES_X,
    RDENT_CHANGED_ANGLES_Y,
    RDENT_CHANGED_ANGLES_Z,
    RDENT_CHANGED_MODELINDEX,
    RDENT_CHANGED_SIZE,
    RDENT_CHANGED_FLAGS,
    RDENT_CHANGED_SOLIDMOVETYPE,
    RDENT_CHANGED_FRAME,
    RDENT_CHANGED_SKIN,
    RDENT_CHANGED_EFFECTS,
    RDENT_CHANGED_BODY,
    RDENT_CHANGED_SCALE,
    RDENT_CHANGED_VELOCITY,
    RDENT_CHANGED_ANGULARVELOCITY,
    RDENT_CHANGED_RENDERCOLOR,
    RDENT_CHANGED_RENDERAMT,
    RDENT_CHANGED_RENDERMODE,
    RDENT_CHANGED_CONTROLLER
} nsrenderableentity_changed_t;
 
typedef enum
{ 
    RM_NORMAL = 0,
    RM_COLOR = 1,
    RM_TEXTURE = 2,
    RM_GLOW = 3,
    RM_SOLID = 4,
    RM_ADDITIVE = 5,
    RM_FULLBRIGHT = 6,
    RM_ADDFRAC = 7, /* Source 2004 */
    RM_WORLDGLOW = 9, /* Source 2004 */
    RM_DONTRENDER = 10, /* Source 2004 */
} rendermode_t;
 
typedef enum
{
    RFX_NORMAL = 0,
    RFX_SLOWPULSE = 1,
    RFX_FASTPULSE = 2,
    RFX_SLOWWIDEPULSE = 3,
    RFX_FASTWIDEPULSE = 4,
    RFX_SLOWFADEAWAY = 5,
    RFX_FASTFADEAWAY = 6,
    RFX_SLOWBECOMESOLID = 7,
    RFX_FASTBECOMESOLID = 8,
    RFX_SLOWSTROBE = 9,
    RFX_FASTSTROBE = 10,
    RFX_FASTERSTROBE = 11,
    RFX_SLOWFLICKER = 12,
    RFX_FASTFLICKER = 13,
    RFX_CONSTANTGLOW = 14,
    RFX_DISTORT = 15,
    RFX_HOLOGRAM = 16,
    RFX_GLOWSHELL = 19,
    RFX_GLOWSHELL2 = 20,
    RFX_Q2PULSE = 21
} renderfx_t;
 
#ifdef CLIENT
var int autocvar_rm_unlit_additive = TRUE;
var int autocvar_rm_unlit_texture = TRUE;
#endif

class ncRenderableEntity:ncEntity
{
public:
    void ncRenderableEntity(void);
 
    virtual void OnRemoveEntity(void);
 
    /* overrides */
    virtual void SpawnKey(string,string);
#ifdef SERVER
    virtual void Input(entity,string,string);
    virtual void Respawn(void);
    virtual void Save(float);
    virtual void Restore(string,string);
    virtual void EvaluateEntity(void);
    virtual float SendEntity(entity,float);
 
    nonvirtual void Event_SpawnDefBone(string, string);
    nonvirtual void Event_SpawnDefAttachment(string, float);
#endif
 
#ifdef CLIENT
    virtual void RenderDebugSkeleton(void);
    virtual void ReceiveEntity(float,float);
    virtual float predraw(void);
    virtual void postdraw(void);
    virtual void ReloadVideoResources();
#endif
 
    virtual void MakeStatic(void);
 
    /* model events */
    virtual void HandleAnimEvent(float,int,string);
 
    /* set */
    nonvirtual void SetBody(int);
    nonvirtual void SetBodyInGroup(int, int);
    nonvirtual void SetRenderFX(float);
    nonvirtual void SetRenderMode(float);
    nonvirtual void SetRenderAmt(float);
    nonvirtual void SetRenderColor(vector);
    nonvirtual void SetBoneController1(float);
    nonvirtual void SetBoneController2(float);
    nonvirtual void SetBoneController3(float);
    nonvirtual void SetBoneController4(float);
    nonvirtual void SetBoneController5(float);
    nonvirtual void SetAxialScale(vector);

    nonvirtual int GetBody(void);
    nonvirtual int GetBodyInGroup(int);
    nonvirtual float GetRenderMode(void);
    nonvirtual float GetRenderFX(void);
    nonvirtual float GetRenderAmt(void);
    nonvirtual vector GetRenderColor(void);
    nonvirtual float GetBoneController1(void);
    nonvirtual float GetBoneController2(void);
    nonvirtual float GetBoneController3(void);
    nonvirtual float GetBoneController4(void);
    nonvirtual float GetBoneController5(void);
    nonvirtual vector GetAxialScale(void);
 
#ifdef CLIENT
    nonvirtual void RenderFXPass(void);
    nonvirtual void RenderAxialScale(void);
    nonvirtual void RenderGLQuakeShadow(void);
#endif
 
private:
    /* new */
    NETWORKED_FLOAT(m_studioBoneController1)
    NETWORKED_FLOAT(m_studioBoneController2)
    NETWORKED_FLOAT(m_studioBoneController3)
    NETWORKED_FLOAT(m_studioBoneController4)
    NETWORKED_FLOAT(m_studioBoneController5)
    NETWORKED_FLOAT_N(modelflags)
    NETWORKED_INT(m_geomsetField)
    NETWORKED_FLOAT_N(colormap)
    NETWORKED_VECTOR_N(glowmod)
    NETWORKED_FLOAT_N(frame1time)
 
    NETWORKED_FLOAT(m_renderFX)
    NETWORKED_FLOAT(m_renderMode)
    NETWORKED_FLOAT(m_renderAmount)
    NETWORKED_VECTOR(m_renderColor)
    NETWORKED_VECTOR(m_axialScale)
 
    /* either a sprite model or a particle */
    NETWORKED_INT(m_iMuzzleModel)
    NETWORKED_INT(m_iMuzzlePart)
    NETWORKED_FLOAT(m_flMuzzleScale)
 
    /* model events */
    float m_modelEventTime;
    float m_iNumBones;
    nonvirtual void _UpdateBoneCount();
 
#ifdef CLIENT
    float m_studioBoneController1Spin;
    float m_studioBoneController2Spin;
    float m_studioBoneController3Spin;
    float m_studioBoneController4Spin;
    float m_studioBoneController5Spin;
    float m_netEffects;
 
    /* muzzle cache */
    string m_muzzPartSmoke;
    vector m_muzzOffset;
    vector m_muzzRelativeOffset;
    float m_fiJointMuzzle; /* World Model only */
    float m_fiJointBarrel; /* View Model only */
 
    nonvirtual void _UpdateGeomset();
#endif
};