List of all members.
Public Member Functions |
| Arrow (gcu::TypeId Type) |
virtual | ~Arrow () |
bool | Load (xmlNodePtr node) |
void | SetSelected (int state) |
void | SetCoords (double xstart, double ystart, double xend, double yend) |
bool | GetCoords (double *xstart, double *ystart, double *xend, double *yend) const |
bool | GetCoords (double *x, double *y, double *z=NULL) const |
void | Move (double x, double y, double z=0) |
void | Transform2D (gcu::Matrix2D &m, double x, double y) |
double | GetYAlign () |
bool | SetProperty (unsigned property, char const *value) |
Protected Member Functions |
bool | Save (xmlDocPtr xml, xmlNodePtr node) const |
Protected Attributes |
double | m_x |
double | m_y |
double | m_width |
double | m_height |
Detailed Description
Definition at line 55 of file gcp/arrow.h.
Constructor & Destructor Documentation
- Parameters:
-
Used to create an arrow of type Id. Should only be called from the constructor of a derived class.
virtual gcp::Arrow::~Arrow |
( |
|
) |
[virtual] |
Member Function Documentation
bool gcp::Arrow::GetCoords |
( |
double * |
xstart, |
|
|
double * |
ystart, |
|
|
double * |
xend, |
|
|
double * |
yend | |
|
) |
| | const |
- Parameters:
-
| xstart | where to store the x coordinate of the start point. |
| ystart | where to store the y coordinate of the start point. |
| xend | where to store the x coordinate of the end point. |
| yend | where to store the y coordinate of the end point. |
Retrieves the position of the arrow.
bool gcp::Arrow::GetCoords |
( |
double * |
x, |
|
|
double * |
y, |
|
|
double * |
z = NULL | |
|
) |
| | const |
- Parameters:
-
| x | a pointer to the double value which will receive the x coordinate of the Arrow. |
| y | a pointer to the double value which will receive the y coordinate of the Arrow. |
| z | a pointer to the double value which will receive the z coordinate of the Arrow or NULL for 2D representations. |
Retrieves the coordinates of this Arrow.
- Returns:
- true if successful and false if an error occurs (if x or y is NULL).
double gcp::Arrow::GetYAlign |
( |
|
) |
|
Used to retrieve the y coordinate for alignment.
- Returns:
- y coordinate used for arrows alignment.
bool gcp::Arrow::Load |
( |
xmlNodePtr |
node |
) |
|
- Parameters:
-
| node,: | a pointer to the xmlNode containing the serialized arrow. |
Used to load an Arrow in memory. This method must be called from derived classes overloaded Load methods.
- Returns:
- true on succes, false otherwise.
Reimplemented in gcp::MesomeryArrow, and gcp::ReactionArrow.
void gcp::Arrow::Move |
( |
double |
x, |
|
|
double |
y, |
|
|
double |
z = 0 | |
|
) |
| | |
- Parameters:
-
| x,: | the x component of the transation vector. |
| y,: | the y component of the transation vector. |
| z,: | the z component of the transation vector (unused). |
Used to move an arrow. The third parameter is not taken into account.
Reimplemented in gcp::ReactionArrow.
bool gcp::Arrow::Save |
( |
xmlDocPtr |
xml, |
|
|
xmlNodePtr |
node | |
|
) |
| | const [protected] |
- Parameters:
-
| xml,: | the xmlDoc used to save the document. |
| node,: | the node representing the Object. |
This method must be called from derived classes overloaded Save methods.
- Returns:
- true on succes, false otherwise.
void gcp::Arrow::SetCoords |
( |
double |
xstart, |
|
|
double |
ystart, |
|
|
double |
xend, |
|
|
double |
yend | |
|
) |
| | |
- Parameters:
-
| xstart | the x coordinate of the start point. |
| ystart | the y coordinate of the start point. |
| xend | the x coordinate of the end point. |
| yend | the y coordinate of the end point. |
Sets the position and length of an arrow.
bool gcp::Arrow::SetProperty |
( |
unsigned |
property, |
|
|
char const * |
value | |
|
) |
| | |
- Parameters:
-
| property | the property id as defined in objprops.h |
| value | the property value as a string |
Used when loading to set common properties to arrows. Only one property is currently supported: gcu::GCU_PROP_ARROW_COORDS.
- Returns:
- true if the property could be set, or if the property is not relevant, false otherwise.
Reimplemented in gcp::ReactionArrow.
void gcp::Arrow::SetSelected |
( |
int |
state |
) |
[virtual] |
void gcp::Arrow::Transform2D |
( |
gcu::Matrix2D & |
m, |
|
|
double |
x, |
|
|
double |
y | |
|
) |
| | |
- Parameters:
-
| m,: | the Matrix2D of the transformation. |
| x,: | the x component of the center of the transformation. |
| y,: | the y component of the center of the transformation. |
Used to move and/or transform an arrow.
Member Data Documentation
The y coordinate to the end point.
Definition at line 174 of file gcp/arrow.h.
The x coordinate to the end point.
Definition at line 170 of file gcp/arrow.h.
The x coordinate to the start point.
Definition at line 162 of file gcp/arrow.h.
The y coordinate to the start point.
Definition at line 166 of file gcp/arrow.h.
The documentation for this class was generated from the following file: