RVC::VECTOR Class Reference
Manages RVC::OBJTYPE_Vector RVC objects. More...
#include <rvc/vector.h>
Detailed Description
Manages RVC::OBJTYPE_Vector RVC objects.
RVC Object Types that this class supports: RVC::OBJTYPE_Vector.
Default RVC Object Type for this class: RVC::OBJTYPE_Vector.
Valid parents for this class:
Member Typedef Documentation
| typedef ELEMITERATOR<LABEL> RVC::VECTOR::LABELITERATOR |
| typedef ELEMITERATOR<LINE> RVC::VECTOR::LINEITERATOR |
| typedef ELEMITERATOR<NODE> RVC::VECTOR::NODEITERATOR |
| typedef ELEMITERATOR<POINT> RVC::VECTOR::POINTITERATOR |
Member Enumeration Documentation
| enum RVC::VECTOR::FLAGS |
| enum RVC::VECTOR::SUBTYPE |
- Enumerator:
Constructor & Destructor Documentation
| RVC::VECTOR::VECTOR | ( | ) |
Default constructor.
| RVC::VECTOR::VECTOR | ( | const RVC::VECTOR & | rhs | ) |
Copy constructor.
| virtual RVC::VECTOR::~VECTOR | ( | ) | [virtual] |
Destructor.
Member Function Documentation
Add a polygon to the vector object.
- Returns:
- Number of the added polygon element or < 0 if error
Add a point to the vector object.
- Returns:
- Number of the added point element or < 0 if error
Add a node to the vector object.
- Returns:
- Number of the added node element or < 0 if error
Add a line to the vector object.
- Returns:
- Number of the added line element or < 0 if error
Add a label to the vector object.
- Returns:
- Number of the added label element or < 0 if error
Add a point to the vector object from a DPOINT3D Will correctly update the extents of the vector Will not correct topology.
- Returns:
- Number of the added point element or < 0 if error
Add a polygon to the vector object Will correctly set the POLYGON and update the extents of the vector Will add the line and set LINE correctly Will not add nodes nor correct topology 'PolyLine' element MUST be closed, or an error is returned.
- Returns:
- Number of the added polygon element or < 0 if error
Add a region to the vector object Will correctly set the POLYGON and update the extents of the vector Will correctly add the islands and set the parent polygon island set.
Will add the lines and set LINE correctly Will not add nodes nor correct topology. Assumes that the 'Region' is in the same Coordinate Reference System (CRS) as the vector object. Since multiple polygon shells can be added, the added element number cannot be returned
| INT32 RVC::VECTOR::AddSubRegion | ( | const SUBREGION2D & | SubRegion | ) |
Add a sub-region to the vector object Will correctly set the POLYGON and update the extents of the vector Will correctly add the islands and set the parent polygon island set.
Will add the lines and set LINE correctly Will not add nodes nor correct topology Assumes that the 'SubRegion' is in the same Coordinate Reference System (CRS) as the vector object.
- Returns:
- Number of the added parent polygon element or < 0 if error
| ERRVALUE RVC::VECTOR::ClearLinePointList | ( | ) | [protected] |
| ERRVALUE RVC::VECTOR::ClearNodeLineList | ( | ) | [protected] |
| ERRVALUE RVC::VECTOR::ClearPolygonIslandList | ( | ) | [protected] |
| ERRVALUE RVC::VECTOR::ClearPolygonLineList | ( | ) | [protected] |
Mark an element as deleted.
| ELEMITERATOR<_ELEM> RVC::VECTOR::ElementBegin | ( | const ELEMITERATOR< _ELEM > & | ) | const [inline] |
Obtain an element iterator to the beginning of the element list.
| ELEMITERATOR<_ELEM> RVC::VECTOR::ElementEnd | ( | const ELEMITERATOR< _ELEM > & | ) | const [inline] |
Obtain an element iterator to the end of the element list.
| ERRVALUE RVC::VECTOR::FindLabelStyleObject | ( | RVC::STYLE & | StyleObj | ) | const |
Locate label style object referenced by 'this' 'StyleObj' will be attached if one is found, unattached if not.
| ERRVALUE RVC::VECTOR::GenerateIsleShellList | ( | INT32 | ParentPolygon, | |
| ORIENTATION | orient, | |||
| SIMPLE_ARRAY< INT32 > & | NumShellLines, | |||
| SIMPLE_ARRAY< INT32 > & | ShellList, | |||
| SIMPLE_ARRAY< DRECT2D > * | RectList = 0 | |||
| ) | const |
Generate the list of islend shell lines for a specific polygon.
- Parameters:
-
ParentPolygon Parent polygon, -1 for external polygon shell list
| ERRVALUE RVC::VECTOR::GenerateNodes | ( | ) |
Generate nodes and set line start/end values based on the lines in the vector object This method will remove all existing nodes.
Generate a point inside of a polygon.
| RVC::VECTOR::FLAGS RVC::VECTOR::GetFlags | ( | ) | const |
Get vector object flags.
- Returns:
- VECTOR::FLAGS
| ERRVALUE RVC::VECTOR::GetLabelStyleInfo | ( | FILEPATH & | filepath, | |
| RVC::OBJECTNAME & | StyleName | |||
| ) | const |
Obtain style object refered to by the label header.
| ERRVALUE RVC::VECTOR::GetMakeParms | ( | RVC::VECTOR::MAKEPARMS & | MakeParms | ) | const |
Get MAKEPARM values from current vector object instance.
| INT32 RVC::VECTOR::GetMaxIslands | ( | ) | const |
Obtain maximum number of islands in a polygon.
- Returns:
- Maximum number of islands
| INT32 RVC::VECTOR::GetMaxLabelStringLength | ( | ) | const |
Obtain maximum length of a label string.
- Returns:
- Maximum length of a label string
| INT32 RVC::VECTOR::GetMaxLines | ( | ) | const |
Obtain maximum number of lines in a polygon or node line list.
- Returns:
- Maximum number of lines
| INT32 RVC::VECTOR::GetMaxPoints | ( | ) | const |
Obtain the maximum number of points a line has.
- Returns:
- Maximum number of points in a line
| INT32 RVC::VECTOR::GetNextLineID | ( | ) | const |
Obtain next available line ID for line ID table.
- Returns:
- Next available line ID
| INT32 RVC::VECTOR::GetNextPointID | ( | ) | const |
Obtain next available point ID for point ID table.
- Returns:
- Next available point ID
| INT32 RVC::VECTOR::GetNextPolygonID | ( | ) | const |
Obtain next available polygon ID for polygon ID table.
- Returns:
- Next available polygon ID
| INT32 RVC::VECTOR::GetNumLabels | ( | ) | const |
Obtain number of labels in the vector object.
- Returns:
- Number of labels
Obtain number of points in a line.
- Returns:
- Number of line points
| INT32 RVC::VECTOR::GetNumLines | ( | ) | const |
Obtain number of lines in the vector object.
- Returns:
- Number of lines
Obtain number of lines in a node.
- Returns:
- Number of node lines
| INT32 RVC::VECTOR::GetNumNodes | ( | ) | const |
Obtain number of nodes in the vector object.
- Returns:
- Number of nodes
| INT32 RVC::VECTOR::GetNumPoints | ( | ) | const |
Obtain number of points in the vector object.
- Returns:
- Number of points
| INT32 RVC::VECTOR::GetNumPolygons | ( | ) | const |
Obtain number of polygons in the vector object.
- Returns:
- Number of polygons
Obtain number of islands in a polygon.
- Returns:
- Number of polygon islands
Obtain number of lines in a polygon.
- Returns:
- Number of polygon lines
| SUBTYPE RVC::VECTOR::GetSubType | ( | ) | const |
Obtain vector sub-type.
- Returns:
- Vector object subtype
| TOPOLOGYTYPE RVC::VECTOR::GetTopologyType | ( | ) | const |
Obtain vector topology type for vector.
- Returns:
- vector RVC::VECTOR::TOPOLOGYTYPE
| INT32 RVC::VECTOR::GetVertexLimit | ( | ) | const |
Obtain limit on the maximum number of vertices a line can have.
- Returns:
- Maximum number of verticies
| bool RVC::VECTOR::IsElementIDTablesValid | ( | ) | const |
Determine if we are able to generate element ID tables for the vector object.
| bool RVC::VECTOR::IsEquivalentTo | ( | const VECTOR & | rhs, | |
| double | threshold | |||
| ) | const |
Determine if the two vector objects are equivalent This method uses "Fuzzy" vertex comparisons and the direction and order of the elements are not relevant.
- Returns:
- 'True' if they are, 'False' if not
Is this point inside the vector polygon specified.
| bool RVC::VECTOR::IsStdAttribTablesValid | ( | ) | const |
Determine if we are able to generate standard attribute tables for the vector object.
| ERRVALUE RVC::VECTOR::Make | ( | RVC::OBJITEM & | ObjItem, | |
| const MAKEPARMS & | MakeParms, | |||
| const char * | Source = 0, |
|||
| const CREDENTIALS * | Credentials = 0 | |||
| ) |
Create new vector object given parent object, name, description, creation parameters, and source.
- Parameters:
-
ObjItem Parent object and DESCRIPTOR of object to create, new location RETURNED Credentials User credentials passed in, NULL for default behavior
| ERRVALUE RVC::VECTOR::Make | ( | const RVC::OBJECT & | parent, | |
| const DESCRIPTOR & | Descriptor, | |||
| const MAKEPARMS & | MakeParms, | |||
| const CREDENTIALS *Credentials | RVC_DEFAULT_CREDENTIALS | |||
| ) |
Create new vector object given parent object, name, description, creation parameters, and source.
- Parameters:
-
RVC_DEFAULT_CREDENTIALS User credentials passed in, NULL for default behavior
| RVC::VECTOR& RVC::VECTOR::operator= | ( | const RVC::VECTOR & | rhs | ) |
Assignment, will close and re-open object if possible.
Reimplemented from RVC::GEOMETRIC.
| ERRVALUE RVC::VECTOR::OptimizeTo | ( | RVC::OBJITEM & | ObjItemTgt | ) |
Optimize vector object to specified target location.
- Parameters:
-
ObjItemTgt Target object location passed/returned
| ERRVALUE RVC::VECTOR::OptimizeTo | ( | RVC::OBJECT & | DestParentObj, | |
| RVC::VECTOR & | DestVectObj | |||
| ) |
Optimize vector object.
- Parameters:
-
DestParentObj Parent object to optimize vector object and copy children to DestVectObj Destination vector object RETURNED
Read a vector polygon given a polygon number.
Read a vector point given a point number.
Read a vector node given a node number.
Read a vector line header given a line number.
Read a vector label given a label number.
| ERRVALUE RVC::VECTOR::ReadConglomerateLinePoints | ( | INT32 | StartLineNum, | |
| POLYLINE & | ConglomerateLine, | |||
| CONGLOMERATELINEFILTER & | filter | |||
| ) | const |
Read a vector line point.
| INT32 RVC::VECTOR::ReadLinePoints | ( | INT32 | LineNum, | |
| INT32 | Start, | |||
| INT32 | Length, | |||
| DPOINT2D * | pts | |||
| ) | const |
Read a partial vector line point list into a POLYLINE.
- Returns:
- Number of points read or error if < 0
| INT32 RVC::VECTOR::ReadLinePoints | ( | INT32 | LineNum, | |
| INT32 | Start, | |||
| INT32 | Length, | |||
| POLYLINE & | LinePoints, | |||
| DIMENSION | dimension | |||
| ) | const |
Read a partial vector line point list into a POLYLINE Define 'dimension' to get 2D or 3D lines.
- Returns:
- Number of points read or error if < 0
| INT32 RVC::VECTOR::ReadLinePoints | ( | INT32 | LineNum, | |
| INT32 | Start, | |||
| INT32 | Length, | |||
| POLYLINE & | LinePoints | |||
| ) | const |
Read a partial vector line point list into a POLYLINE.
- Returns:
- Number of points read or error if < 0
| INT32 RVC::VECTOR::ReadLinePoints | ( | INT32 | LineNum, | |
| POLYLINE & | LinePoints, | |||
| DIMENSION | dimension | |||
| ) | const |
Read a vector line point list using the vector POINTYPE into a POLYLINE Define 'dimension' to get 2D or 3D lines.
- Returns:
- Number of points read or error if < 0
| ERRVALUE RVC::VECTOR::ReadNodeLines | ( | INT32 | NodeNum, | |
| INT32 | Start, | |||
| INT32 | Length, | |||
| SIMPLE_ARRAY< INT32 > & | LineList | |||
| ) | const |
Read a partial vector node line list into a SIMPLE_ARRAY<INT32>.
| ERRVALUE RVC::VECTOR::ReadNodeLines | ( | INT32 | NodeNum, | |
| SIMPLE_ARRAY< INT32 > & | LineList | |||
| ) | const |
Read a vector node line list into a SIMPLE_ARRAY<INT32>.
| ERRVALUE RVC::VECTOR::ReadPolyIslands | ( | INT32 | PolyNum, | |
| INT32 | Start, | |||
| INT32 | Length, | |||
| SIMPLE_ARRAY< INT32 > & | IsleList | |||
| ) | const |
Read a partial vector polygon island list into a SIMPLE_ARRAY<INT32>.
| ERRVALUE RVC::VECTOR::ReadPolyIslands | ( | INT32 | PolyNum, | |
| SIMPLE_ARRAY< INT32 > & | IsleList | |||
| ) | const |
Read a vector polygon island list into a SIMPLE_ARRAY<INT32>.
| ERRVALUE RVC::VECTOR::ReadPolyLines | ( | INT32 | PolyNum, | |
| INT32 | Start, | |||
| INT32 | Length, | |||
| SIMPLE_ARRAY< INT32 > & | LineList | |||
| ) | const |
Read a partial vector polygon line list into a SIMPLE_ARRAY<INT32>.
| ERRVALUE RVC::VECTOR::ReadPolyLines | ( | INT32 | PolyNum, | |
| SIMPLE_ARRAY< INT32 > & | LineList | |||
| ) | const |
Read a vector polygon line list into a SIMPLE_ARRAY<INT32>.
| ERRVALUE RVC::VECTOR::ReadRegion | ( | const BITSET_UNOWNED & | PolySet, | |
| REGION2D & | Region, | |||
| BITSET * | LineSet = 0, |
|||
| bool | NoIslands = false | |||
| ) | const |
Read a set of vector polygon and possibly its islands into a REGION2D.
- Parameters:
-
PolySet Set of polygons to generate region from Region Region to set LineSet Set of lines that made up the region, can be NULL NoIslands 'True' of no islands wanted
| ERRVALUE RVC::VECTOR::ReadRegion | ( | const BITSET_UNOWNED & | PolySet, | |
| REGION2D & | Region, | |||
| DIMENSION | dim, | |||
| BITSET * | LineSet = 0, |
|||
| bool | NoIslands = false | |||
| ) | const |
Read a set of vector polygon and possibly its islands into a REGION2D.
- Parameters:
-
PolySet Set of polygons to generate region from Region Region to set LineSet Set of lines that made up the region, can be NULL NoIslands 'True' of no islands wanted
| ERRVALUE RVC::VECTOR::ReadSubRegion | ( | INT32 | PolyNum, | |
| SUBREGION2D & | SubRegion, | |||
| bool | NoIslands = false | |||
| ) | const |
Read a vector polygon and possibly its islands into a SUBREGION2D.
- Parameters:
-
PolyNum Polygon to generate region from
| ERRVALUE RVC::VECTOR::ReadSubRegion | ( | INT32 | PolyNum, | |
| SUBREGION2D & | SubRegion, | |||
| DIMENSION | dim, | |||
| bool | NoIslands = false | |||
| ) | const |
Read a vector polygon and possibly its islands into a SUBREGION2D.
- Parameters:
-
PolyNum Polygon to generate region from
| ERRVALUE RVC::VECTOR::SetFlags | ( | RVC::VECTOR::FLAGS | flags | ) |
Set vector object flags.
| ERRVALUE RVC::VECTOR::SetLabelStyleInfo | ( | const FILEPATH & | filepath, | |
| const RVC::OBJECTNAME & | StyleName | |||
| ) |
Set style object refered to by the label header.
Set next available line ID for line ID table.
Set next available point ID for point ID table.
Set next available polygon ID for polygon ID table.
| ERRVALUE RVC::VECTOR::SetTopologyType | ( | TOPOLOGYTYPE | TopologyType | ) |
Set vector topology type.
Write a vector polygon given a polygon number Does not update element nor object extents.
Write a vector point given a point number Does not update element nor object extents.
Write a vector node given a node number Does not update element nor object extents.
Write a vector line given a line number Does not update element nor object extents.
Write a vector label given a label number Does not update element nor object extents.
Write a vector line point Does not update element nor object extents.
| INT32 RVC::VECTOR::WriteLinePoints | ( | INT32 | LineNum, | |
| INT32 | Start, | |||
| INT32 | Length, | |||
| const POLYLINE & | PointList | |||
| ) |
Write a partial vector line point list Does not update element nor object extents.
- Returns:
- Number of line points written or error if < 0
Write a vector line point list Does not update element nor object extents.
- Returns:
- Number of line points written or error if < 0
| INT32 RVC::VECTOR::WriteNodeLines | ( | INT32 | NodeNum, | |
| INT32 | NumLines, | |||
| INT32 | Start, | |||
| INT32 | Length, | |||
| const SIMPLE_ARRAY< INT32 > & | LineList | |||
| ) |
Write a partial vector node line list from a SIMPLE_ARRAY<INT32> Does not update element nor object extents.
- Returns:
- Number of node lines written or error if < 0
| INT32 RVC::VECTOR::WriteNodeLines | ( | INT32 | NodeNum, | |
| const SIMPLE_ARRAY< INT32 > & | LineList | |||
| ) |
Write a vector node line list from a SIMPLE_ARRAY<INT32> Does not update element nor object extents.
- Returns:
- Number of node lines written or error if < 0
| INT32 RVC::VECTOR::WritePolyIslands | ( | INT32 | PolyNum, | |
| INT32 | NumIslands, | |||
| INT32 | Start, | |||
| INT32 | Length, | |||
| const SIMPLE_ARRAY< INT32 > & | IsleList | |||
| ) |
Write a partial vector polygon island list from a SIMPLE_ARRAY<INT32> Does not update element nor object extents.
- Returns:
- Number of polygon islands written or error if < 0
| INT32 RVC::VECTOR::WritePolyIslands | ( | INT32 | PolyNum, | |
| const SIMPLE_ARRAY< INT32 > & | IsleList | |||
| ) |
Write a vector polygon island list from a SIMPLE_ARRAY<INT32> Does not update element nor object extents.
- Returns:
- Number of polygon islands written or error if < 0
| INT32 RVC::VECTOR::WritePolyLines | ( | INT32 | PolyNum, | |
| INT32 | NumLines, | |||
| INT32 | Start, | |||
| INT32 | Length, | |||
| const SIMPLE_ARRAY< INT32 > & | LineList | |||
| ) |
Write a partial vector polygon line list from a SIMPLE_ARRAY<INT32> Does not update element nor object extents.
- Returns:
- Number of polygon lines written or error if < 0
| INT32 RVC::VECTOR::WritePolyLines | ( | INT32 | PolyNum, | |
| const SIMPLE_ARRAY< INT32 > & | LineList | |||
| ) |
Write a vector polygon line list from a SIMPLE_ARRAY<INT32> Does not update element nor object extents.
- Returns:
- Number of polygon lines written or error if < 0
The documentation for this class was generated from the following file:
- rvc/vector.h
