linearSegmentRecord.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 1992-2025 MAK Technologies, Inc
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <vl/packets/linObjStP.h>
#include <vlpi/disEnums.h>

class DT_DLL_VL DtLinearSegmentRecord
{
public:

   DtLinearSegmentRecord();

   DtLinearSegmentRecord( const DtLinearSegmentRecord& orig );

   virtual ~DtLinearSegmentRecord();


   virtual DtLinearSegmentRecord& operator = ( const DtLinearSegmentRecord& orig );
   virtual DtLinearSegmentRecord& operator = ( const DtNetLinearSegmentRecord& orig );
   virtual DtLinearSegmentRecord& operator = ( const DtNetLinearSegmentParameter& orig );



   virtual bool operator == ( const DtLinearSegmentRecord& rec ) const;
   virtual bool operator != ( const DtLinearSegmentRecord& rec ) const;


   virtual void setSegmentNumber( const DtU32 value );
   virtual DtU32 segmentNumber() const;

#if DtDIS

   virtual void setModifications(DtU8 value);
   virtual DtU8 modifications() const;

   virtual void setModificationsField(
      DtModificationField field, bool value);
   virtual bool modificationsField(
      DtModificationField field) const;

#endif

   virtual void setLocation( const DtVector& coords );
   virtual const DtVector& location() const;

   virtual void setOrientation( const DtTaitBryan& orientation );
   virtual const DtTaitBryan& orientation() const;

   virtual void setLength( const DtU16 value );
   virtual DtU16 length() const;

   virtual void setWidth( const DtU16 value );
   virtual DtU16 width() const;

   virtual void setHeight( const DtU16 value );
   virtual DtU16 height() const;

   virtual void setDepth( const DtU16 value );
   virtual DtU16 depth() const;

   virtual void setGeneralAppearance( DtU16 appearance );
   virtual DtU16 generalAppearance() const;

   virtual void setSpecificAppearance( DtU32 appearance );
   virtual DtU32 specificAppearance() const;

   virtual void setGeneralAppearanceAttribute(
      DtAppearAttribute attr, DtAppearAttrVal val );
   virtual DtAppearAttrVal generalAppearanceAttribute(
      DtAppearAttribute attr ) const;

   virtual void setSpecificAppearanceAttribute(
      DtAppearAttribute attr, DtAppearAttrVal val );
   virtual DtU32 specificAppearanceAttribute(
      DtAppearAttribute attr ) const;

   virtual void setPercentComplete( const DtU32 value );
   virtual DtU32 percentComplete() const;

   virtual void setDamagedState( const DtDamageState state );
   virtual DtDamageState damagedState() const;

   virtual void setObjectPreDistributed( bool onOff );
   virtual bool objectPreDistributed() const;

   virtual void setDeactivated( bool onOff );
   virtual bool deactivated() const;

   virtual void setSmoking( bool onOff );
   virtual bool smoking() const;

   virtual void setFlaming( bool onOff );
   virtual bool flaming() const;

   virtual void printData() const;
   virtual void printDataToStream( std::ostream& stream ) const;

   virtual void unloadNetRecord( const DtNetLinearSegmentParameter& record );
   virtual void loadNetRecord( DtNetLinearSegmentParameter& record ) const;

   virtual void unloadNetRecord( const DtNetLinearSegmentRecord& record );
   virtual void loadNetRecord( DtNetLinearSegmentRecord& record ) const;

protected:

   DtU32 mySegmentNumber;
#if DtDIS
   DtU8 myModifications;
#endif
   DtVector myLocation;
   DtTaitBryan myOrientation;
   DtU16 myLength;
   DtU16 myWidth;
   DtU16 myHeight;
   DtU16 myDepth;

   DtU16 myGeneralAppearance;
   DtU32 mySpecificAppearance;

};