LVectorRectangle::LockObject
#include "ltwrappr.h"
virtual L_INT LVectorRectangle::LockObject(pObject)
|
pVECTORRECTANGLE pObject; |
/* pointer to a vector object */ |
Gets the object information of the class object.
|
Parameter |
Description |
|
pObject |
Pointer to a VECTORRECTANGLE structure to be updated with the vector object information. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
This function is used to retrieve the object information of the class object.
To use this method, declare a variable of the VECTORRECTANGLE type and pass the address to this function. After modifying the vector object settings, call LVectorRectangle::UnlockObject (). LVectorRectangle::LockObject() and LVectorRectangle::UnlockObject () should always be called in pairs.
Before an object has been added to the LVectorBase object, using LVectorBase::AddObject or LVectorLayer::AddObject, LVectorRectangle::UnlockObject () can be used to change ALL properties of an object. However, once the object has been added to the LVectorBase object, some properties cannot be changed using LVectorRectangle::UnlockObject ().However, as long as the number of points does not change, the coordinates of the individual points can always be modified using LVectorRectangle::UnlockObject ().
To change the object information for a class object, call LVectorRectangle::UnlockObject.
LVectorRectangle::LockObject and LVectorRectangle::UnlockObject must be called in pairs.
Note that rotating an object may change the object type. However, not all object types are changed by rotation, and not all rotations result in changing an object type. For example, a rectangle rotated 90 degrees about the z-axis is still a rectangle. A rectangle rotated 45 degrees about the z-axis becomes a polydraw object. The table below indicates object types that may change following rotation and the possible resulting object types.
|
Original object type |
Possible object type following rotation |
|
VECTOR_RECTANGLE |
VECTOR_POLYGON |
|
VECTOR_ELLIPSE |
VECTOR_POLYDRAW |
|
VECTOR_CIRCLE |
VECTOR_POLYDRAW |
|
VECTOR_ARC |
VECTOR_POLYDRAW |
|
VECTOR_TEXT |
VECTOR_POLYDRAW |
|
VECTOR_PIE |
VECTOR_POLYDRAW |
If an object type changes, LVectorRectangle::LockObject and LVectorRectangle::UnlockObject will return WRPERR_VECTOR_INVALID_OBJECT_TYPE. Object properties can still be inspected and changed by using LVectorObject::GetObjectAttributes and LVectorObject::SetObjectAttributes.
Required DLLs and Libraries
|
LVKRN For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
See Also
|
Functions: |
|
|
Topics: |
Example
For an example, refer to LVectorObject::UnlockObject.