SurfacePlatformAppearance.h

Go to the documentation of this file.

/*********************************************************************
Copyright 2013 Karl Jones
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer. 
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution. 

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

For Further Information Please Contact me at
Karljj1@yahoo.com
http://p.sf.net/kdis/UserGuide
*********************************************************************/

/********************************************************************
    class:      SurfacePlatformAppearance
    created:    22/09/2008 - Updated March 2012
    author:     Karl Jones

    purpose:    Represents the appearance of a surface platform.
                Implemented as struct so as to prevent the size from
                changing due to RTTI etc. This struct will be part of a
                union with all specific appearance values so it is implemented
                slightly different.
                No constructors to prevent C2620 error caused by union of
                classes/structs.
    size:       32 Bits / 4 Octet
*********************************************************************/

#pragma once

#include "./../KDefines.h"
#include "./Enums/KDISEnums.h"

namespace KDIS {
namespace DATA_TYPE {

struct KDIS_EXPORT SurfacePlatformAppearance
{
protected:
                                         // Bits 
    KUINT32 m_PaintScheme           : 1; // 0
    KUINT32 m_MobilityKill          : 1; // 1
    KUINT32 m_Unused1               : 1; // 2
    KUINT32 m_Damage                : 2; // 3-4
    KUINT32 m_Smoke                 : 2; // 5-6
    KUINT32 m_TrailingEffect        : 2; // 7-8
        KUINT32 m_Unused2               : 3; // 9-11
    KUINT32 m_RunningLights         : 1; // 12
        KUINT32 m_Unused3               : 2; // 13-14
    KUINT32 m_FlamingEffectField    : 1; // 15    
    KUINT32 m_Unused4               : 5; // 16-20        
    KUINT32 m_FrozenStatus          : 1; // 21
    KUINT32 m_PowerPlantStatus      : 1; // 22
    KUINT32 m_State                 : 1; // 23     
    KUINT32 m_Unused5               : 4; // 24-27       
        KUINT32 m_SpotLights            : 1; // 28
        KUINT32 m_InteriorLights        : 1; // 29
        KUINT32 m_Unused6               : 2; // 30 - 31

public:

    //************************************
    // FullName:    KDIS::DATA_TYPE::SurfacePlatformAppearance::SetEntityPaintScheme
    //              KDIS::DATA_TYPE::SurfacePlatformAppearance::GetEntityPaintScheme
    //!Description: Describes the paint scheme of an entity.
    // Parameter:   EntityPaintScheme EPS
    //************************************
    void SetEntityPaintScheme( KDIS::DATA_TYPE::ENUMS::EntityPaintScheme EPS );
    KDIS::DATA_TYPE::ENUMS::EntityPaintScheme GetEntityPaintScheme() const;

    //************************************
    // FullName:    KDIS::DATA_TYPE::SurfacePlatformAppearance::SetEntityMobilityKill
    //              KDIS::DATA_TYPE::SurfacePlatformAppearance::DoesEntityMobilityKill
    //!Description: Mobility/Propulsion Kill True/False?
    // Parameter:   KBOOL MK
    //************************************
    void SetEntityMobilityKill( KBOOL MK );
    KBOOL DoesEntityMobilityKill() const;

    //************************************
    // FullName:    KDIS::DATA_TYPE::SurfacePlatformAppearance::SetEntityDamage
    //              KDIS::DATA_TYPE::SurfacePlatformAppearance::GetEntityDamage
    //!Description: Entity Damage State
    // Parameter:   EntityDamage ED
    //************************************
    void SetEntityDamage( KDIS::DATA_TYPE::ENUMS::EntityDamage ED );
    KDIS::DATA_TYPE::ENUMS::EntityDamage GetEntityDamage() const;

    //************************************
    // FullName:    KDIS::DATA_TYPE::SurfacePlatformAppearance::SetEntitySmoke,
    //              KDIS::DATA_TYPE::SurfacePlatformAppearance::GetEntitySmoke
    //!Description: Entity Smoke State
    // Parameter:   EntitySmoke ES
    //************************************
    void SetEntitySmoke( KDIS::DATA_TYPE::ENUMS::EntitySmoke ES );
    KDIS::DATA_TYPE::ENUMS::EntitySmoke GetEntitySmoke() const;

    //************************************
    // FullName:    KDIS::DATA_TYPE::SurfacePlatformAppearance::SetEntityTrailingEffect
    //              KDIS::DATA_TYPE::SurfacePlatformAppearance::GetEntityTrailingEffect
    //!Description: Describes the size of the dust cloud/trailing effect.
    // Parameter:   EntityTrailingEffect ETE
    //************************************
    void SetEntityTrailingEffect( KDIS::DATA_TYPE::ENUMS::EntityTrailingEffect ETE );
    KDIS::DATA_TYPE::ENUMS::EntityTrailingEffect GetEntityTrailingEffect() const;

    //************************************
    // FullName:    KDIS::DATA_TYPE::SurfacePlatformAppearance::SetEntityRunningLights
    //              KDIS::DATA_TYPE::SurfacePlatformAppearance::IsEntityRunningLightsOn
    //!Description: Are the vehicles running lights turned on? True = On, False = Off.
    // Parameter:   KBOOL RL
    //************************************
    void SetEntityRunningLights( KBOOL RL );
    KBOOL IsEntityRunningLightsOn() const;

    //************************************
    // FullName:    KDIS::DATA_TYPE::SurfacePlatformAppearance::SetEntityFlamingEffect
    //              KDIS::DATA_TYPE::SurfacePlatformAppearance::IsEntityFlaming
    //!Description: Are flames rising from the entity?
    // Parameter:   KBOOL EFE
    //************************************
    void SetEntityFlamingEffect( KBOOL EFE );
    KBOOL IsEntityFlaming() const;

        //************************************
    // FullName:    KDIS::DATA_TYPE::SurfacePlatformAppearance::SetEntityFrozenStatus
    //              KDIS::DATA_TYPE::SurfacePlatformAppearance::IsEntityFrozen
    //!Description: Is the entity frozen?
    //!             Note: Frozen entities should not be dead-reckoned, they should remain 
        //!             frozen in place. You would likely freeze entites when your application is
        //!             in a paused state.
    // Parameter:   KBOOL EFS
    //************************************
    void SetEntityFrozenStatus( KBOOL EFS );
    KBOOL IsEntityFrozen() const;

    //************************************
    // FullName:    KDIS::DATA_TYPE::SurfacePlatformAppearance::SetEntityPowerPlantOn
    //              KDIS::DATA_TYPE::SurfacePlatformAppearance::IsEntityPowerPlantOn
    //!Description: Power Plant On/Off. True = On, False = Off.
    // Parameter:   KBOOL EPPS
    //************************************
    void SetEntityPowerPlantOn( KBOOL EPPS );
    KBOOL IsEntityPowerPlantOn() const;

    //************************************
    // FullName:    KDIS::DATA_TYPE::SurfacePlatformAppearance::SetEntityStateActive
    //              KDIS::DATA_TYPE::SurfacePlatformAppearance::IsEntityStateActive
    //!Description: True = Active, False = Deactivated.
    // Parameter:   KBOOL ES
    //************************************
    void SetEntityStateActive( KBOOL ES );
    KBOOL IsEntityStateActive() const;

        //************************************
    // FullName:    KDIS::DATA_TYPE::SurfacePlatformAppearance::SetEntityBlackoutBrakeLights
    //              KDIS::DATA_TYPE::SurfacePlatformAppearance::IsEntityBlackoutBrakeLightsOn
    //!Description: Are the vehicles spot lights turned on? True = On, False = Off.
    // Parameter:   KBOOL SL
    //************************************
    void SetEntitySpotLights( KBOOL SL );
    KBOOL IsEntitySpotLightsOn() const;

        //************************************
    // FullName:    KDIS::DATA_TYPE::SurfacePlatformAppearance::SetEntityInteriorLights
    //              KDIS::DATA_TYPE::SurfacePlatformAppearance::IsEntityInteriorLightsOn
    //!Description: Are the vehicles interior lights turned on? True = On, False = Off.
    // Parameter:   KBOOL IL
    //************************************
    void SetEntityInteriorLights( KBOOL IL );
    KBOOL IsEntityInteriorLightsOn() const;
        
    //************************************
    // FullName:    KDIS::DATA_TYPE::SurfacePlatformAppearance::GetAsString
    //!Description: Returns a string representation.
    //************************************
    KString GetAsString() const;

    KBOOL operator == ( const SurfacePlatformAppearance & Value ) const;
    KBOOL operator != ( const SurfacePlatformAppearance & Value ) const;
};

} // END namespace DATA_TYPES
} // END namespace KDIS