placement_c Class Reference

this class contains the information for the placement of one piece within the assembly. More...

#include <assembly.h>

List of all members.

Public Member Functions

 placement_c (unsigned char tran, int x, int y, int z)
 initialize placement with given values
 placement_c (const placement_c *orig)
 copy constructor
 placement_c (const placement_c &orig)
 copy constructor
int getX (void) const
 get x position of piece
int getY (void) const
 get y position of piece
int getZ (void) const
 get z position of piece
unsigned char getTransformation (void) const
 get transformation of piece
bool operator== (const placement_c &b) const
 check if 2 placements are identical
placement_coperator= (const placement_c &b)
 assignment operation
bool operator< (const placement_c &b) const
 comparison operation, this is an arbitrary oerder for placements

Public Attributes

unsigned char transformation
 the transformation of the piece.
int xpos
 position of the hotspot of the piece
int ypos
int zpos


Detailed Description

this class contains the information for the placement of one piece within the assembly.

That is the position and the orientation of that piece Only internally used in assembly


Constructor & Destructor Documentation

placement_c::placement_c ( unsigned char  tran,
int  x,
int  y,
int  z 
) [inline]

initialize placement with given values

placement_c::placement_c ( const placement_c orig  )  [inline]

copy constructor

placement_c::placement_c ( const placement_c orig  )  [inline]

copy constructor


Member Function Documentation

unsigned char placement_c::getTransformation ( void   )  const [inline]

get transformation of piece

References transformation.

int placement_c::getX ( void   )  const [inline]

get x position of piece

References xpos.

int placement_c::getY ( void   )  const [inline]

get y position of piece

References ypos.

int placement_c::getZ ( void   )  const [inline]

get z position of piece

References zpos.

bool placement_c::operator< ( const placement_c b  )  const [inline]

comparison operation, this is an arbitrary oerder for placements

References transformation, xpos, ypos, and zpos.

placement_c& placement_c::operator= ( const placement_c b  )  [inline]

assignment operation

References transformation, xpos, ypos, and zpos.

bool placement_c::operator== ( const placement_c b  )  const [inline]

check if 2 placements are identical

References transformation, xpos, ypos, and zpos.


Member Data Documentation

the transformation of the piece.

if transformation is equal to UNPLACED_TRANS then the piece in NOT placed inside the assembly

Referenced by getTransformation(), operator<(), operator=(), and operator==().

position of the hotspot of the piece

Referenced by getX(), operator<(), operator=(), and operator==().

Referenced by getY(), operator<(), operator=(), and operator==().

Referenced by getZ(), operator<(), operator=(), and operator==().


The documentation for this class was generated from the following file:

Generated on Sun Oct 10 10:03:02 2010 for BurrTools by  doxygen 1.5.8