#include <CigiBaseSymbolSurfaceDef.h>
Inheritance diagram for CigiBaseSymbolSurfaceDef:
Public Types | |
Active = 0 | |
Destroyed = 1 | |
EntityAttached = 0 | |
ViewAttached = 1 | |
NotBillboard = 0 | |
Billboard = 1 | |
Disable = 0 | |
Enable = 1 | |
enum | StateGrp { Active = 0, Destroyed = 1 } |
enum | AttachStateGrp { EntityAttached = 0, ViewAttached = 1 } |
enum | BillboardStateGrp { NotBillboard = 0, Billboard = 1 } |
enum | PerspectiveGrowthStateGrp { Disable = 0, Enable = 1 } |
Public Member Functions | |
CigiBaseSymbolSurfaceDef (void) | |
virtual | ~CigiBaseSymbolSurfaceDef (void) |
virtual int | Pack (CigiBasePacket *Base, Cigi_uint8 *Buff, void *Spec) const =0 |
virtual int | Unpack (Cigi_uint8 *Buff, bool Swap, void *Spec)=0 |
virtual int | GetCnvt (CigiVersionID &CnvtVersion, CigiCnvtInfoType::Type &CnvtInfo) |
int | SetSurfaceID (const Cigi_uint16 SurfaceIDIn, bool bndchk=true) |
Cigi_uint16 | GetSurfaceID (void) const |
int | SetSurfaceState (const StateGrp SurfaceStateIn, bool bndchk=true) |
StateGrp | GetSurfaceState (void) const |
int | SetAttached (const AttachStateGrp AttachedIn, bool bndchk=true) |
AttachStateGrp | GetAttached (void) const |
int | SetBillboardState (const BillboardStateGrp BillboardStateIn, bool bndchk=true) |
BillboardStateGrp | GetBillboardState (void) const |
int | SetPerspectiveGrowth (const PerspectiveGrowthStateGrp PerspectiveGrowthIn, bool bndchk=true) |
PerspectiveGrowthStateGrp | GetPerspectiveGrowth (void) const |
int | SetEntityID (const Cigi_uint16 EntityIDIn, bool bndchk=true) |
Cigi_uint16 | GetEntityID (void) const |
int | SetViewID (const Cigi_uint16 ViewIDIn, bool bndchk=true) |
Cigi_uint16 | GetViewID (void) const |
int | SetXOffset (const float XOffsetIn, bool bndchk=true) |
float | GetXOffset (void) const |
int | SetYOffset (const float YOffsetIn, bool bndchk=true) |
float | GetYOffset (void) const |
int | SetZOffset (const float ZOffsetIn, bool bndchk=true) |
float | GetZOffset (void) const |
int | SetYaw (const float YawIn, bool bndchk=true) |
float | GetYaw (void) const |
int | SetPitch (const float PitchIn, bool bndchk=true) |
float | GetPitch (void) const |
int | SetRoll (const float RollIn, bool bndchk=true) |
float | GetRoll (void) const |
int | SetWidth (const float WidthIn, bool bndchk=true) |
float | GetWidth (void) const |
int | SetHeight (const float HeightIn, bool bndchk=true) |
float | GetHeight (void) const |
int | SetLeftEdgePosition (const float LeftEdgePosition, bool bndchk=true) |
float | GetLeftEdgePosition (void) const |
int | SetRightEdgePosition (const float RightEdgePosition, bool bndchk=true) |
float | GetRightEdgePosition (void) const |
int | SetTopEdgePosition (const float TopEdgePosition, bool bndchk=true) |
float | GetTopEdgePosition (void) const |
int | SetBottomEdgePosition (const float BottomEdgePosition, bool bndchk=true) |
float | GetBottomEdgePosition (void) const |
int | SetMinU (const float MinUIn, bool bndchk=true) |
float | GetMinU (void) const |
int | SetMaxU (const float MaxUIn, bool bndchk=true) |
float | GetMaxU (void) const |
int | SetMinV (const float MinVIn, bool bndchk=true) |
float | GetMinV (void) const |
int | SetMaxV (const float MaxVIn, bool bndchk=true) |
float | GetMaxV (void) const |
Protected Attributes | |
Cigi_uint16 | SurfaceID |
StateGrp | SurfaceState |
AttachStateGrp | Attached |
BillboardStateGrp | BillboardState |
PerspectiveGrowthStateGrp | PerspectiveGrowth |
Cigi_uint16 | EntityViewID |
float | XLeft |
float | YRight |
float | ZTop |
float | YawBottom |
float | Pitch |
float | Roll |
float | Width |
float | Height |
float | MinU |
float | MaxU |
float | MinV |
float | MaxV |
Friends | |
class | CigiSymbolSurfaceDefV3_3 |
Definition at line 59 of file CigiBaseSymbolSurfaceDef.h.
The enumeration for the Enitity/View Attached flag
Definition at line 79 of file CigiBaseSymbolSurfaceDef.h.
00080 { 00081 EntityAttached=0, 00082 ViewAttached=1 00083 };
The enumeration for the Billboard State flag
Definition at line 88 of file CigiBaseSymbolSurfaceDef.h.
00089 { 00090 NotBillboard=0, 00091 Billboard=1 00092 };
The enumeration for the Perspective Growth flag
Definition at line 97 of file CigiBaseSymbolSurfaceDef.h.
The enumeration for the CigiBaseSymbolSurfaceDef State Group
Definition at line 70 of file CigiBaseSymbolSurfaceDef.h.
CigiBaseSymbolSurfaceDef::CigiBaseSymbolSurfaceDef | ( | void | ) |
CigiBaseSymbolSurfaceDef::~CigiBaseSymbolSurfaceDef | ( | void | ) | [virtual] |
AttachStateGrp CigiBaseSymbolSurfaceDef::GetAttached | ( | void | ) | const [inline] |
Gets the Attached State value
Definition at line 223 of file CigiBaseSymbolSurfaceDef.h.
References Attached.
00223 { return(Attached); }
BillboardStateGrp CigiBaseSymbolSurfaceDef::GetBillboardState | ( | void | ) | const [inline] |
Gets the Surface State value
Definition at line 242 of file CigiBaseSymbolSurfaceDef.h.
References BillboardState.
00242 { return(BillboardState); }
float CigiBaseSymbolSurfaceDef::GetBottomEdgePosition | ( | void | ) | const [inline] |
Gets The position of the Bottom Edge using a linear scale from the bottom edge of the view (0.0) to the top edge of the view (1.0)
Definition at line 547 of file CigiBaseSymbolSurfaceDef.h.
References YawBottom.
00547 { return(YawBottom); }
int CigiBaseSymbolSurfaceDef::GetCnvt | ( | CigiVersionID & | CnvtVersion, | |
CigiCnvtInfoType::Type & | CnvtInfo | |||
) | [virtual] |
A virtual Conversion Information function. This function provides conversion information for this packet.
CnvtVersion | - The CIGI version to which this packet is being converted. | |
CnvtInfo | - The information needed for conversion including convertion type and packet id. |
Reimplemented from CigiBasePacket.
Definition at line 75 of file CigiBaseSymbolSurfaceDef.cpp.
References CIGI_SUCCESS, CIGI_SYMBOL_SURFACE_DEF_PACKET_ID_V3_3, CigiCnvtInfoType::CigiCnvtInfoStruct::CnvtPacketID, CigiVersionID::GetCombinedCigiVersion(), CigiCnvtInfoType::CigiCnvtInfoStruct::ProcID, CigiProcessType::ProcNone, and CigiProcessType::ProcStd.
00077 { 00078 if(CnvtVersion.GetCombinedCigiVersion() < 0x303) 00079 { 00080 CnvtInfo.ProcID = CigiProcessType::ProcNone; 00081 CnvtInfo.CnvtPacketID = 0; 00082 } 00083 else 00084 { 00085 CnvtInfo.ProcID = CigiProcessType::ProcStd; 00086 CnvtInfo.CnvtPacketID = CIGI_SYMBOL_SURFACE_DEF_PACKET_ID_V3_3; 00087 } 00088 00089 return(CIGI_SUCCESS); 00090 }
Cigi_uint16 CigiBaseSymbolSurfaceDef::GetEntityID | ( | void | ) | const [inline] |
Gets the Entity ID value to which this surface is attached.
Definition at line 286 of file CigiBaseSymbolSurfaceDef.h.
References EntityViewID.
00286 { return(EntityViewID); }
float CigiBaseSymbolSurfaceDef::GetHeight | ( | void | ) | const [inline] |
Gets the Height of the entity attached surface.
Definition at line 467 of file CigiBaseSymbolSurfaceDef.h.
References Height.
00467 { return(Height); }
float CigiBaseSymbolSurfaceDef::GetLeftEdgePosition | ( | void | ) | const [inline] |
Gets The position of the Left Edge using a linear scale from the left edge of the view (0.0) to the right edge of the view (1.0)
Definition at line 490 of file CigiBaseSymbolSurfaceDef.h.
References XLeft.
00490 { return(XLeft); }
float CigiBaseSymbolSurfaceDef::GetMaxU | ( | void | ) | const [inline] |
Gets the Right Edge U Coordinate of the surface. This is the Right most U coordinate contained within the surface boundaries.
Definition at line 594 of file CigiBaseSymbolSurfaceDef.h.
References MaxU.
00594 { return(MaxU); }
float CigiBaseSymbolSurfaceDef::GetMaxV | ( | void | ) | const [inline] |
Gets the Top Edge V Coordinate of the surface. This is the Top most V coordinate contained within the surface boundaries.
Definition at line 638 of file CigiBaseSymbolSurfaceDef.h.
References MaxV.
00638 { return(MaxV); }
float CigiBaseSymbolSurfaceDef::GetMinU | ( | void | ) | const [inline] |
Gets the Left Edge Coordinate of the surface. This is the left most U coordinate contained within the surface boundaries.
Definition at line 572 of file CigiBaseSymbolSurfaceDef.h.
References MinU.
00572 { return(MinU); }
float CigiBaseSymbolSurfaceDef::GetMinV | ( | void | ) | const [inline] |
Gets the Bottom Edge V Coordinate of the surface. This is the Bottom most V coordinate contained within the surface boundaries.
Definition at line 616 of file CigiBaseSymbolSurfaceDef.h.
References MinV.
00616 { return(MinV); }
PerspectiveGrowthStateGrp CigiBaseSymbolSurfaceDef::GetPerspectiveGrowth | ( | void | ) | const [inline] |
Gets the Perspective Growth value
Definition at line 263 of file CigiBaseSymbolSurfaceDef.h.
References PerspectiveGrowth.
00263 { return(PerspectiveGrowth); }
float CigiBaseSymbolSurfaceDef::GetPitch | ( | void | ) | const [inline] |
Gets the Pitch of the surface with respect to the Entity's body coordinate system.
Definition at line 409 of file CigiBaseSymbolSurfaceDef.h.
References Pitch.
00409 { return(Pitch); }
float CigiBaseSymbolSurfaceDef::GetRightEdgePosition | ( | void | ) | const [inline] |
Gets The position of the Right Edge using a linear scale from the left edge of the view (0.0) to the right edge of the view (1.0)
Definition at line 509 of file CigiBaseSymbolSurfaceDef.h.
References YRight.
00509 { return(YRight); }
float CigiBaseSymbolSurfaceDef::GetRoll | ( | void | ) | const [inline] |
Gets the Roll of the surface with respect to the Entity's body coordinate system.
Definition at line 426 of file CigiBaseSymbolSurfaceDef.h.
References Roll.
00426 { return(Roll); }
Cigi_uint16 CigiBaseSymbolSurfaceDef::GetSurfaceID | ( | void | ) | const [inline] |
Gets the Surface ID value
Definition at line 183 of file CigiBaseSymbolSurfaceDef.h.
References SurfaceID.
00183 { return(SurfaceID); }
StateGrp CigiBaseSymbolSurfaceDef::GetSurfaceState | ( | void | ) | const [inline] |
Gets the Surface State value
Definition at line 203 of file CigiBaseSymbolSurfaceDef.h.
References SurfaceState.
00203 { return(SurfaceState); }
float CigiBaseSymbolSurfaceDef::GetTopEdgePosition | ( | void | ) | const [inline] |
Gets The position of the Top Edge using a linear scale from the bottom edge of the view (0.0) to the top edge of the view (1.0)
Definition at line 528 of file CigiBaseSymbolSurfaceDef.h.
References ZTop.
00528 { return(ZTop); }
Cigi_uint16 CigiBaseSymbolSurfaceDef::GetViewID | ( | void | ) | const [inline] |
Gets the View ID value to which this surface is attached.
Definition at line 306 of file CigiBaseSymbolSurfaceDef.h.
References EntityViewID.
00306 { return(EntityViewID); }
float CigiBaseSymbolSurfaceDef::GetWidth | ( | void | ) | const [inline] |
Gets the Width of the entity attached surface.
Definition at line 448 of file CigiBaseSymbolSurfaceDef.h.
References Width.
00448 { return(Width); }
float CigiBaseSymbolSurfaceDef::GetXOffset | ( | void | ) | const [inline] |
Gets the Offset along the Entity's body X axis from the Entity to the attached surface.
Definition at line 330 of file CigiBaseSymbolSurfaceDef.h.
References XLeft.
00330 { return(XLeft); }
float CigiBaseSymbolSurfaceDef::GetYaw | ( | void | ) | const [inline] |
Gets the Yaw of the surface with respect to the Entity's body coordinate system.
Definition at line 392 of file CigiBaseSymbolSurfaceDef.h.
References YawBottom.
00392 { return(YawBottom); }
float CigiBaseSymbolSurfaceDef::GetYOffset | ( | void | ) | const [inline] |
Gets the Offset along the Entity's body Y axis from the Entity to the attached surface.
Definition at line 351 of file CigiBaseSymbolSurfaceDef.h.
References YRight.
00351 { return(YRight); }
float CigiBaseSymbolSurfaceDef::GetZOffset | ( | void | ) | const [inline] |
Gets the Offset along the Entity's body Z axis from the Entity to the attached surface.
Definition at line 372 of file CigiBaseSymbolSurfaceDef.h.
References ZTop.
00372 { return(ZTop); }
virtual int CigiBaseSymbolSurfaceDef::Pack | ( | CigiBasePacket * | Base, | |
Cigi_uint8 * | Buff, | |||
void * | Spec | |||
) | const [pure virtual] |
A pure virtual Pack function. This function is not implemented in this class.
Base | - A pointer to the instance of the packet to be packed. (Downcast to CigiBasePacket) | |
Buff | - A pointer to the current pack point. | |
Spec | - A pointer to special data. |
Implements CigiBasePacket.
Implemented in CigiSymbolSurfaceDefV3_3.
int CigiBaseSymbolSurfaceDef::SetAttached | ( | const AttachStateGrp | AttachedIn, | |
bool | bndchk = true | |||
) |
Sets the Attached State with bound checking control
AttachedIn | - The commanded Attachment or independance of this surface (Entity Attached/View Attached) | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 124 of file CigiBaseSymbolSurfaceDef.cpp.
References Attached, CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, EntityAttached, and ViewAttached.
00126 { 00127 00128 #ifndef CIGI_NO_BND_CHK 00129 if(bndchk && ((AttachedIn < EntityAttached) || 00130 (AttachedIn > ViewAttached))) 00131 { 00132 #ifndef CIGI_NO_EXCEPT 00133 throw CigiValueOutOfRangeException("Attached State", 00134 (int)AttachedIn,0,1); 00135 #endif 00136 return(CIGI_ERROR_VALUE_OUT_OF_RANGE); 00137 } 00138 #endif 00139 00140 Attached = AttachedIn; 00141 00142 return(CIGI_SUCCESS); 00143 00144 }
int CigiBaseSymbolSurfaceDef::SetBillboardState | ( | const BillboardStateGrp | BillboardStateIn, | |
bool | bndchk = true | |||
) |
Sets the Billboard State with bound checking control
BillboardStateIn | - The commanded "Billboard" or "NotBillboard" state of this surface | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 149 of file CigiBaseSymbolSurfaceDef.cpp.
References Billboard, BillboardState, CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and NotBillboard.
00151 { 00152 00153 #ifndef CIGI_NO_BND_CHK 00154 if(bndchk && ((BillboardStateIn < NotBillboard) || 00155 (BillboardStateIn > Billboard))) 00156 { 00157 #ifndef CIGI_NO_EXCEPT 00158 throw CigiValueOutOfRangeException("Billboard State", 00159 (int)BillboardStateIn,0,1); 00160 #endif 00161 return(CIGI_ERROR_VALUE_OUT_OF_RANGE); 00162 } 00163 #endif 00164 00165 BillboardState = BillboardStateIn; 00166 00167 return(CIGI_SUCCESS); 00168 00169 }
int CigiBaseSymbolSurfaceDef::SetBottomEdgePosition | ( | const float | BottomEdgePosition, | |
bool | bndchk = true | |||
) |
Sets the Bottom Edge Position of the surface.
BottomEdgePosition | - The position of the Bottom Edge using a linear scale from the bottom edge of the view (0.0) to the top edge of the view (1.0) | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 346 of file CigiBaseSymbolSurfaceDef.cpp.
References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and YawBottom.
00348 { 00349 00350 #ifndef CIGI_NO_BND_CHK 00351 if(bndchk && ((BottomEdgePosition < 0.0) || 00352 (BottomEdgePosition > 1.0))) 00353 { 00354 #ifndef CIGI_NO_EXCEPT 00355 throw CigiValueOutOfRangeException("Bottom Edge Position", 00356 (float)BottomEdgePosition,0.0,1.0); 00357 #endif 00358 return(CIGI_ERROR_VALUE_OUT_OF_RANGE); 00359 } 00360 #endif 00361 00362 YawBottom = BottomEdgePosition; 00363 00364 return(CIGI_SUCCESS); 00365 00366 }
int CigiBaseSymbolSurfaceDef::SetEntityID | ( | const Cigi_uint16 | EntityIDIn, | |
bool | bndchk = true | |||
) | [inline] |
Sets the Entity ID with bound checking control
EntityIDIn | - The ID of the Entity to which this surface is attached. | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 276 of file CigiBaseSymbolSurfaceDef.h.
References CIGI_SUCCESS, and EntityViewID.
00277 { 00278 EntityViewID = EntityIDIn; 00279 return(CIGI_SUCCESS); 00280 }
int CigiBaseSymbolSurfaceDef::SetHeight | ( | const float | HeightIn, | |
bool | bndchk = true | |||
) | [inline] |
Sets the Height of the entity attached surface.
HeightIn | - The Height of the surface. | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 457 of file CigiBaseSymbolSurfaceDef.h.
References CIGI_SUCCESS, and Height.
00458 { 00459 Height = HeightIn; 00460 return(CIGI_SUCCESS); 00461 }
int CigiBaseSymbolSurfaceDef::SetLeftEdgePosition | ( | const float | LeftEdgePosition, | |
bool | bndchk = true | |||
) |
Sets the Left Edge Position of the surface.
LeftEdgePosition | - The position of the Left Edge using a linear scale from the left edge of the view (0.0) to the right edge of the view (1.0) | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 271 of file CigiBaseSymbolSurfaceDef.cpp.
References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and XLeft.
00273 { 00274 00275 #ifndef CIGI_NO_BND_CHK 00276 if(bndchk && ((LeftEdgePosition < 0.0) || 00277 (LeftEdgePosition > 1.0))) 00278 { 00279 #ifndef CIGI_NO_EXCEPT 00280 throw CigiValueOutOfRangeException("Left Edge Position", 00281 (float)LeftEdgePosition,0.0,1.0); 00282 #endif 00283 return(CIGI_ERROR_VALUE_OUT_OF_RANGE); 00284 } 00285 #endif 00286 00287 XLeft = LeftEdgePosition; 00288 00289 return(CIGI_SUCCESS); 00290 00291 }
int CigiBaseSymbolSurfaceDef::SetMaxU | ( | const float | MaxUIn, | |
bool | bndchk = true | |||
) | [inline] |
Sets the Right Edge U Coordinate of the surface. This specifies the Right most U coordinate contained within the surface boundaries.
MaxUIn | - The Right Edge U Coordinate. | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 583 of file CigiBaseSymbolSurfaceDef.h.
References CIGI_SUCCESS, and MaxU.
00584 { 00585 MaxU = MaxUIn; 00586 return(CIGI_SUCCESS); 00587 }
int CigiBaseSymbolSurfaceDef::SetMaxV | ( | const float | MaxVIn, | |
bool | bndchk = true | |||
) | [inline] |
Sets the Top Edge V Coordinate of the surface. This specifies the Top most V coordinate contained within the surface boundaries.
MaxVIn | - The Top Edge V Coordinate. | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 627 of file CigiBaseSymbolSurfaceDef.h.
References CIGI_SUCCESS, and MaxV.
00628 { 00629 MaxV = MaxVIn; 00630 return(CIGI_SUCCESS); 00631 }
int CigiBaseSymbolSurfaceDef::SetMinU | ( | const float | MinUIn, | |
bool | bndchk = true | |||
) | [inline] |
Sets the Left Edge U Coordinate of the surface. This specifies the left most U coordinate contained within the surface boundaries.
MinUIn | - The Left Edge U Coordinate. | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 561 of file CigiBaseSymbolSurfaceDef.h.
References CIGI_SUCCESS, and MinU.
00562 { 00563 MinU = MinUIn; 00564 return(CIGI_SUCCESS); 00565 }
int CigiBaseSymbolSurfaceDef::SetMinV | ( | const float | MinVIn, | |
bool | bndchk = true | |||
) | [inline] |
Sets the Bottom Edge V Coordinate of the surface. This specifies the Bottom most V coordinate contained within the surface boundaries.
MinVIn | - The Bottom Edge V Coordinate. | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 605 of file CigiBaseSymbolSurfaceDef.h.
References CIGI_SUCCESS, and MinV.
00606 { 00607 MinV = MinVIn; 00608 return(CIGI_SUCCESS); 00609 }
int CigiBaseSymbolSurfaceDef::SetPerspectiveGrowth | ( | const PerspectiveGrowthStateGrp | PerspectiveGrowthIn, | |
bool | bndchk = true | |||
) |
Sets the Perspective Growth with bound checking control
PerspectiveGrowthIn | - Enables or Disables the Perspective Growth of this surface, if the surface is a Billboard. | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 174 of file CigiBaseSymbolSurfaceDef.cpp.
References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, Disable, Enable, and PerspectiveGrowth.
00176 { 00177 00178 #ifndef CIGI_NO_BND_CHK 00179 if(bndchk && ((PerspectiveGrowthIn < Disable) || 00180 (PerspectiveGrowthIn > Enable))) 00181 { 00182 #ifndef CIGI_NO_EXCEPT 00183 throw CigiValueOutOfRangeException("Perspective Growth", 00184 (int)PerspectiveGrowthIn,0,1); 00185 #endif 00186 return(CIGI_ERROR_VALUE_OUT_OF_RANGE); 00187 } 00188 #endif 00189 00190 PerspectiveGrowth = PerspectiveGrowthIn; 00191 00192 return(CIGI_SUCCESS); 00193 00194 }
int CigiBaseSymbolSurfaceDef::SetPitch | ( | const float | PitchIn, | |
bool | bndchk = true | |||
) |
Sets the Pitch of the surface with respect to the Entity's body coordinate system with bound checking control
PitchIn | - The Pitch of the surface. | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 223 of file CigiBaseSymbolSurfaceDef.cpp.
References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Pitch.
00224 { 00225 00226 #ifndef CIGI_NO_BND_CHK 00227 if(bndchk && ((PitchIn < -90.0) || 00228 (PitchIn > 90.0))) 00229 { 00230 #ifndef CIGI_NO_EXCEPT 00231 throw CigiValueOutOfRangeException("Pitch", 00232 (float)PitchIn,-90.0,90.0); 00233 #endif 00234 return(CIGI_ERROR_VALUE_OUT_OF_RANGE); 00235 } 00236 #endif 00237 00238 Pitch = PitchIn; 00239 00240 return(CIGI_SUCCESS); 00241 00242 }
int CigiBaseSymbolSurfaceDef::SetRightEdgePosition | ( | const float | RightEdgePosition, | |
bool | bndchk = true | |||
) |
Sets the Right Edge Position of the surface.
RightEdgePosition | - The position of the Right Edge using a linear scale from the left edge of the view (0.0) to the right edge of the view (1.0) | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 296 of file CigiBaseSymbolSurfaceDef.cpp.
References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and YRight.
00298 { 00299 00300 #ifndef CIGI_NO_BND_CHK 00301 if(bndchk && ((RightEdgePosition < 0.0) || 00302 (RightEdgePosition > 1.0))) 00303 { 00304 #ifndef CIGI_NO_EXCEPT 00305 throw CigiValueOutOfRangeException("Right Edge Position", 00306 (float)RightEdgePosition,0.0,1.0); 00307 #endif 00308 return(CIGI_ERROR_VALUE_OUT_OF_RANGE); 00309 } 00310 #endif 00311 00312 YRight = RightEdgePosition; 00313 00314 return(CIGI_SUCCESS); 00315 00316 }
int CigiBaseSymbolSurfaceDef::SetRoll | ( | const float | RollIn, | |
bool | bndchk = true | |||
) |
Sets the Roll of the surface with respect to the Entity's body coordinate system with bound checking control
RollIn | - The Roll of the surface. | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 247 of file CigiBaseSymbolSurfaceDef.cpp.
References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and Roll.
00248 { 00249 00250 #ifndef CIGI_NO_BND_CHK 00251 if(bndchk && ((RollIn < -180.0) || 00252 (RollIn > 180.0))) 00253 { 00254 #ifndef CIGI_NO_EXCEPT 00255 throw CigiValueOutOfRangeException("Roll", 00256 (float)RollIn,-180.0,180.0); 00257 #endif 00258 return(CIGI_ERROR_VALUE_OUT_OF_RANGE); 00259 } 00260 #endif 00261 00262 Roll = RollIn; 00263 00264 return(CIGI_SUCCESS); 00265 00266 }
int CigiBaseSymbolSurfaceDef::SetSurfaceID | ( | const Cigi_uint16 | SurfaceIDIn, | |
bool | bndchk = true | |||
) | [inline] |
Sets the Surface ID with bound checking control
SurfaceIDIn | - The ID of this surface | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 173 of file CigiBaseSymbolSurfaceDef.h.
References CIGI_SUCCESS, and SurfaceID.
00174 { 00175 SurfaceID = SurfaceIDIn; 00176 return(CIGI_SUCCESS); 00177 }
int CigiBaseSymbolSurfaceDef::SetSurfaceState | ( | const StateGrp | SurfaceStateIn, | |
bool | bndchk = true | |||
) |
Sets the Surface State with bound checking control
SurfaceStateIn | - The commanded state of this surface (Active/Destroyed) | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 100 of file CigiBaseSymbolSurfaceDef.cpp.
References Active, CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, Destroyed, and SurfaceState.
00102 { 00103 00104 #ifndef CIGI_NO_BND_CHK 00105 if(bndchk && ((SurfaceStateIn < Active)||(SurfaceStateIn > Destroyed))) 00106 { 00107 #ifndef CIGI_NO_EXCEPT 00108 throw CigiValueOutOfRangeException("Surface State", 00109 (int)SurfaceStateIn,0,1); 00110 #endif 00111 return(CIGI_ERROR_VALUE_OUT_OF_RANGE); 00112 } 00113 #endif 00114 00115 SurfaceState = SurfaceStateIn; 00116 00117 return(CIGI_SUCCESS); 00118 00119 }
int CigiBaseSymbolSurfaceDef::SetTopEdgePosition | ( | const float | TopEdgePosition, | |
bool | bndchk = true | |||
) |
Sets the Top Edge Position of the surface.
TopEdgePosition | - The position of the Top Edge using a linear scale from the bottom edge of the view (0.0) to the top edge of the view (1.0) | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 321 of file CigiBaseSymbolSurfaceDef.cpp.
References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and ZTop.
00323 { 00324 00325 #ifndef CIGI_NO_BND_CHK 00326 if(bndchk && ((TopEdgePosition < 0.0) || 00327 (TopEdgePosition > 1.0))) 00328 { 00329 #ifndef CIGI_NO_EXCEPT 00330 throw CigiValueOutOfRangeException("Top Edge Position", 00331 (float)TopEdgePosition,0.0,1.0); 00332 #endif 00333 return(CIGI_ERROR_VALUE_OUT_OF_RANGE); 00334 } 00335 #endif 00336 00337 ZTop = TopEdgePosition; 00338 00339 return(CIGI_SUCCESS); 00340 00341 }
int CigiBaseSymbolSurfaceDef::SetViewID | ( | const Cigi_uint16 | ViewIDIn, | |
bool | bndchk = true | |||
) | [inline] |
Sets the View ID with bound checking control
ViewIDIn | - The ID of the View to which this surface is attached. | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 296 of file CigiBaseSymbolSurfaceDef.h.
References CIGI_SUCCESS, and EntityViewID.
00297 { 00298 EntityViewID = ViewIDIn; 00299 return(CIGI_SUCCESS); 00300 }
int CigiBaseSymbolSurfaceDef::SetWidth | ( | const float | WidthIn, | |
bool | bndchk = true | |||
) | [inline] |
Sets the Width of the entity attached surface.
WidthIn | - The width of the surface. | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 438 of file CigiBaseSymbolSurfaceDef.h.
References CIGI_SUCCESS, and Width.
00439 { 00440 Width = WidthIn; 00441 return(CIGI_SUCCESS); 00442 }
int CigiBaseSymbolSurfaceDef::SetXOffset | ( | const float | XOffsetIn, | |
bool | bndchk = true | |||
) | [inline] |
Sets the Offset along the Entity's body X axis from the Entity to the attached surface with bound checking control
XOffsetIn | - The X Offset. | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 319 of file CigiBaseSymbolSurfaceDef.h.
References CIGI_SUCCESS, and XLeft.
00320 { 00321 XLeft = XOffsetIn; 00322 return(CIGI_SUCCESS); 00323 }
int CigiBaseSymbolSurfaceDef::SetYaw | ( | const float | YawIn, | |
bool | bndchk = true | |||
) |
Sets the Yaw of the surface with respect to the Entity's body coordinate system with bound checking control
YawIn | - The Yaw of the surface. | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 199 of file CigiBaseSymbolSurfaceDef.cpp.
References CIGI_ERROR_VALUE_OUT_OF_RANGE, CIGI_SUCCESS, and YawBottom.
00200 { 00201 00202 #ifndef CIGI_NO_BND_CHK 00203 if(bndchk && ((YawIn < 0.0) || 00204 (YawIn > 360.0))) 00205 { 00206 #ifndef CIGI_NO_EXCEPT 00207 throw CigiValueOutOfRangeException("Yaw", 00208 (float)YawIn,0.0,360.0); 00209 #endif 00210 return(CIGI_ERROR_VALUE_OUT_OF_RANGE); 00211 } 00212 #endif 00213 00214 YawBottom = YawIn; 00215 00216 return(CIGI_SUCCESS); 00217 00218 }
int CigiBaseSymbolSurfaceDef::SetYOffset | ( | const float | YOffsetIn, | |
bool | bndchk = true | |||
) | [inline] |
Sets the Offset along the Entity's body Y axis from the Entity to the attached surface with bound checking control
YOffsetIn | - The Y Offset. | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 340 of file CigiBaseSymbolSurfaceDef.h.
References CIGI_SUCCESS, and YRight.
00341 { 00342 YRight = YOffsetIn; 00343 return(CIGI_SUCCESS); 00344 }
int CigiBaseSymbolSurfaceDef::SetZOffset | ( | const float | ZOffsetIn, | |
bool | bndchk = true | |||
) | [inline] |
Sets the Offset along the Entity's body Z axis from the Entity to the attached surface with bound checking control
XOffsetIn | - The Z Offset. | |
bndchk | - Enables (true) or disables (false) bounds checking. |
Definition at line 361 of file CigiBaseSymbolSurfaceDef.h.
References CIGI_SUCCESS, and ZTop.
00362 { 00363 ZTop = ZOffsetIn; 00364 return(CIGI_SUCCESS); 00365 }
virtual int CigiBaseSymbolSurfaceDef::Unpack | ( | Cigi_uint8 * | Buff, | |
bool | Swap, | |||
void * | Spec | |||
) | [pure virtual] |
A pure virtual Unpack function. This function is not implemented in this class.
Buff | - A pointer to the current pack point. | |
Swap | - N/A for V1 & V2 | |
Spec | - A pointer to special data. |
Implements CigiBasePacket.
Implemented in CigiSymbolSurfaceDefV3_3.
friend class CigiSymbolSurfaceDefV3_3 [friend] |
Definition at line 63 of file CigiBaseSymbolSurfaceDef.h.
AttachStateGrp CigiBaseSymbolSurfaceDef::Attached [protected] |
Attached
This parameter specifies whether the surface should be attached to an entity or a view.
Definition at line 671 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetAttached(), CigiSymbolSurfaceDefV3_3::Pack(), SetAttached(), and CigiSymbolSurfaceDefV3_3::Unpack().
BillBoardState
This parameter specifies whether the surface should be oriented toward the eyepoint (BillBoard). If the surface is a billboard and is attached to a entity, a normal from the center of the surface will intersect the eyepoint.
Definition at line 680 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetBillboardState(), CigiSymbolSurfaceDefV3_3::Pack(), SetBillboardState(), and CigiSymbolSurfaceDefV3_3::Unpack().
Cigi_uint16 CigiBaseSymbolSurfaceDef::EntityViewID [protected] |
EntityViewID
This parameter specifies the entity or view to which this surface is attached.
Definition at line 694 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetEntityID(), GetViewID(), CigiSymbolSurfaceDefV3_3::Pack(), SetEntityID(), SetViewID(), and CigiSymbolSurfaceDefV3_3::Unpack().
float CigiBaseSymbolSurfaceDef::Height [protected] |
Height
If the surface is attached to an entity, this parameter specifies the height of the surface. If the surface is not a billboard or a billboard with perspective growth as determined by the Billboard and Perspective Growth Enable parameters of this data packet, this parameter specifies the height of the surface in meters and the occupied view space is affected by perspective. If the surface is a billboard with perspective growth disabled, this parameter specifies the height as a view arc and the occupied view space remains constant and unaffected by perspective.
Definition at line 797 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetHeight(), CigiSymbolSurfaceDefV3_3::Pack(), SetHeight(), and CigiSymbolSurfaceDefV3_3::Unpack().
float CigiBaseSymbolSurfaceDef::MaxU [protected] |
MaxU
This parameter specifies the right most U coordinate contained within the surface boundaries.
Definition at line 811 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetMaxU(), CigiSymbolSurfaceDefV3_3::Pack(), SetMaxU(), and CigiSymbolSurfaceDefV3_3::Unpack().
float CigiBaseSymbolSurfaceDef::MaxV [protected] |
MaxV
This parameter specifies the top most V coordinate contained within the surface boundaries.
Definition at line 825 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetMaxV(), CigiSymbolSurfaceDefV3_3::Pack(), SetMaxV(), and CigiSymbolSurfaceDefV3_3::Unpack().
float CigiBaseSymbolSurfaceDef::MinU [protected] |
MinU
This parameter specifies the left most U coordinate contained within the surface boundaries.
Definition at line 804 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetMinU(), CigiSymbolSurfaceDefV3_3::Pack(), SetMinU(), and CigiSymbolSurfaceDefV3_3::Unpack().
float CigiBaseSymbolSurfaceDef::MinV [protected] |
MinV
This parameter specifies the bottom most V coordinate contained within the surface boundaries.
Definition at line 818 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetMinV(), CigiSymbolSurfaceDefV3_3::Pack(), SetMinV(), and CigiSymbolSurfaceDefV3_3::Unpack().
Attached
If the surface is an Entity attached billboarded surface, This parameter specifies the Perspective Growth state.
Definition at line 687 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetPerspectiveGrowth(), CigiSymbolSurfaceDefV3_3::Pack(), SetPerspectiveGrowth(), and CigiSymbolSurfaceDefV3_3::Unpack().
float CigiBaseSymbolSurfaceDef::Pitch [protected] |
Pitch
For a surface attached to an entity, this parameter specifies the surface’s pitch with respect to the surface’s reference plane after the yaw rotation has been applied.
Definition at line 756 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetPitch(), CigiSymbolSurfaceDefV3_3::Pack(), SetPitch(), and CigiSymbolSurfaceDefV3_3::Unpack().
float CigiBaseSymbolSurfaceDef::Roll [protected] |
Roll
For a surface attached to an entity, this parameter specifies the surface’s roll with respect to the surface’s reference plane after yaw and pitch rotations have been applied.
Definition at line 765 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetRoll(), CigiSymbolSurfaceDefV3_3::Pack(), SetRoll(), and CigiSymbolSurfaceDefV3_3::Unpack().
Cigi_uint16 CigiBaseSymbolSurfaceDef::SurfaceID [protected] |
SurfaceID
This parameter specifies the symbol surface to which this packet is applied.
Definition at line 651 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetSurfaceID(), CigiSymbolSurfaceDefV3_3::Pack(), SetSurfaceID(), and CigiSymbolSurfaceDefV3_3::Unpack().
StateGrp CigiBaseSymbolSurfaceDef::SurfaceState [protected] |
SurfaceState
This parameter specifies whether the symbol surface should be active or destroyed. Active - The surface is active and symbols may be drawn on it. It can be positioned, oriented, and sized. It can also be attached to an entity or a view. Destroyed - The surface is removed from the system. Any symbols drawn to it are also destroyed. All other parameters in this packet are ignored.
Definition at line 664 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetSurfaceState(), CigiSymbolSurfaceDefV3_3::Pack(), SetSurfaceState(), and CigiSymbolSurfaceDefV3_3::Unpack().
float CigiBaseSymbolSurfaceDef::Width [protected] |
Width
If the surface is attached to an entity, this parameter specifies the width of the surface. If the surface is not a billboard or a billboard with perspective growth as determined by the Billboard and Perspective Growth Enable parameters of this data packet, this parameter specifies the width of the surface in meters and the occupied view space is affected by perspective. If the surface is a billboard with perspective growth disabled, this parameter specifies the width as a view arc and the occupied view space remains constant and unaffected by perspective.
Definition at line 781 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetWidth(), CigiSymbolSurfaceDefV3_3::Pack(), SetWidth(), and CigiSymbolSurfaceDefV3_3::Unpack().
float CigiBaseSymbolSurfaceDef::XLeft [protected] |
XLeft
For a surface attached to an entity, this parameter specifies an X offset position from the entity’s reference point to the center of the surface. For a surface attached to a view, this parameter specifies the position of the surface’s leftmost boundary on the view frustum near clipping plane as a linear distance from the left edge of the view. Where (0.0) is the left edge of the view and (1.0) is the right edge of the view.
Definition at line 707 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetLeftEdgePosition(), GetXOffset(), CigiSymbolSurfaceDefV3_3::Pack(), SetLeftEdgePosition(), SetXOffset(), and CigiSymbolSurfaceDefV3_3::Unpack().
float CigiBaseSymbolSurfaceDef::YawBottom [protected] |
YawBottom
For a surface attached to an entity, this parameter specifies the yaw orientation or a rotation about the surface’s Z axis when the surface’s X axis is parallel to the entity’s X axis. For a surface attached to a view, this parameter specifies the position of the surface’s bottommost boundary on the view frustum near clipping plane as a linear distance from the bottom edge of the view. Where (0.0) is the bottom edge of the view and (1.0) is the top edge of the view.
Definition at line 747 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetBottomEdgePosition(), GetYaw(), CigiSymbolSurfaceDefV3_3::Pack(), SetBottomEdgePosition(), SetYaw(), and CigiSymbolSurfaceDefV3_3::Unpack().
float CigiBaseSymbolSurfaceDef::YRight [protected] |
YRight
For a surface attached to an entity, this parameter specifies an Y offset position from the entity’s reference point to the center of the surface. For a surface attached to a view, this parameter specifies the position of the surface’s rightmost boundary on the view frustum near clipping plane as a linear distance from the left edge of the view. Where (0.0) is the left edge of the view and (1.0) is the right edge of the view.
Definition at line 720 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetRightEdgePosition(), GetYOffset(), CigiSymbolSurfaceDefV3_3::Pack(), SetRightEdgePosition(), SetYOffset(), and CigiSymbolSurfaceDefV3_3::Unpack().
float CigiBaseSymbolSurfaceDef::ZTop [protected] |
ZTop
For a surface attached to an entity, this parameter specifies an Z offset position from the entity’s reference point to the center of the surface. For a surface attached to a view, this parameter specifies the position of the surface’s topmost boundary on the view frustum near clipping plane as a linear distance from the bottom edge of the view. Where (0.0) is the bottom edge of the view and (1.0) is the top edge of the view.
Definition at line 733 of file CigiBaseSymbolSurfaceDef.h.
Referenced by CigiSymbolSurfaceDefV3_3::CigiSymbolSurfaceDefV3_3(), GetTopEdgePosition(), GetZOffset(), CigiSymbolSurfaceDefV3_3::Pack(), SetTopEdgePosition(), SetZOffset(), and CigiSymbolSurfaceDefV3_3::Unpack().