Difference between revisions of "LavishNav:lnavregion (Object Type)"
Jump to navigation
Jump to search
| Line 13: | Line 13: | ||
*[[DataType:bool|bool]] '''InheritedAvoid''': | *[[DataType:bool|bool]] '''InheritedAvoid''': | ||
*[[DataType:bool|bool]] '''AnyAvoid''': | *[[DataType:bool|bool]] '''AnyAvoid''': | ||
| − | |||
*[[DataType:bool|bool]] '''AllPointsValid''': | *[[DataType:bool|bool]] '''AllPointsValid''': | ||
| + | *[[DataType:bool|bool]] '''Contains['''x''','''y''','''z''']''': | ||
*[[DataType:string|string]] '''Type''': | *[[DataType:string|string]] '''Type''': | ||
*[[DataType:string|string]] '''Custom['''name''']''': | *[[DataType:string|string]] '''Custom['''name''']''': | ||
| − | *... '''AddChild['''type''','''name''','''...''']''': | + | *... '''AddChild['''type''','''name''','''...''']''': Adds a child region given a type (such as point) and a name. Extra parameters are used to construct the new region. To construct a unique region, use -unique. To construct a region that defines a coordinate system, use -coordinatesystem. These must be the first extra parameters, before any region type-specific parameters. |
*... '''FindRegion['''search''']''': Finds a region with a relative [[LavishNav:Region Name Search|Region Name Search]] | *... '''FindRegion['''search''']''': Finds a region with a relative [[LavishNav:Region Name Search|Region Name Search]] | ||
*point3f '''NearestPoint''': | *point3f '''NearestPoint''': | ||
*point3f '''CenterPoint''': | *point3f '''CenterPoint''': | ||
| + | *... '''CoordinateSystem''': The region that defines the coordinate system for this particular region | ||
== Methods == | == Methods == | ||
*'''Clear''': Resets the region such that it will contain no child regions | *'''Clear''': Resets the region such that it will contain no child regions | ||
*'''Import['''filename''']''': Imports a LavishNav XML file as children of this region | *'''Import['''filename''']''': Imports a LavishNav XML file as children of this region | ||
| + | *'''Export['''filename''']''': Exports this region and its children to a LavishNav XML file | ||
| + | *'''ExportChildren['''filename''']''': Exports this region's children to a LavishNav XML file | ||
*'''Remove''': Removes the region | *'''Remove''': Removes the region | ||
*'''Connect''': not yet implemented | *'''Connect''': not yet implemented | ||
| Line 33: | Line 36: | ||
*'''SetUnique['''value''']''': Sets the unique flag | *'''SetUnique['''value''']''': Sets the unique flag | ||
*'''SetAvoid['''value''']''': Sets the avoid flag | *'''SetAvoid['''value''']''': Sets the avoid flag | ||
| + | *'''AddChild['''type''','''name''','''...''']''': | ||
| + | *'''Connect['''search''']''': | ||
== Inherits == | == Inherits == | ||
Revision as of 18:41, 12 March 2006
Description
Members
- ... Parent:
- ... Children:
- ... Next:
- ... Previous:
- uint ID:
- string Name:
- string FQN:
- bool Unique:
- bool Avoid:
- bool InheritedAvoid:
- bool AnyAvoid:
- bool AllPointsValid:
- bool Contains[x,y,z]:
- string Type:
- string Custom[name]:
- ... AddChild[type,name,...]: Adds a child region given a type (such as point) and a name. Extra parameters are used to construct the new region. To construct a unique region, use -unique. To construct a region that defines a coordinate system, use -coordinatesystem. These must be the first extra parameters, before any region type-specific parameters.
- ... FindRegion[search]: Finds a region with a relative Region Name Search
- point3f NearestPoint:
- point3f CenterPoint:
- ... CoordinateSystem: The region that defines the coordinate system for this particular region
Methods
- Clear: Resets the region such that it will contain no child regions
- Import[filename]: Imports a LavishNav XML file as children of this region
- Export[filename]: Exports this region and its children to a LavishNav XML file
- ExportChildren[filename]: Exports this region's children to a LavishNav XML file
- Remove: Removes the region
- Connect: not yet implemented
- Disconnect: not yet implemented
- SetCustom[name,text]: Creates a custom data point
- UnsetCustom[name]: Removes a custom data point
- SetAllPointsValid[value]: Sets the "All points valid" flag
- SetUnique[value]: Sets the unique flag
- SetAvoid[value]: Sets the avoid flag
- AddChild[type,name,...]:
- Connect[search]:
Inherits
none
Returns
NULL
