SplitRegion Method (UV, RectangularGridSegmentOrientation, Int32)


Splits the region which contains the specified grid point by a line with the specified direction.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 2015.0.0.0 (2015.0.0.0)

Syntax

C#
public int SplitRegion(
	UV gridUV,
	RectangularGridSegmentOrientation splitDirection,
	out int newSegmentId
)
Visual Basic
Public Function SplitRegion ( _
	gridUV As UV, _
	splitDirection As RectangularGridSegmentOrientation, _
	<OutAttribute> ByRef newSegmentId As Integer _
) As Integer
Visual C++
public:
int SplitRegion(
	UV^ gridUV, 
	RectangularGridSegmentOrientation splitDirection, 
	[OutAttribute] int% newSegmentId
)

Parameters

gridUV
Type: Autodesk.Revit.DB UV
Coordinates of a point in the rectangular grid of this compound structure.
splitDirection
Type: Autodesk.Revit.DB RectangularGridSegmentOrientation
Specifies the direction of the split.
newSegmentId
Type: System Int32 %
The id of segment that bounds both the original region and the new region.

Return Value

The id of the region created by this operation.

Remarks

This method is meant to be used in conjunction with FindEnclosingRegionAndSegments(UV, RectangularGridSegmentOrientation, Int32 , Int32 ) . Grid coordinates correspond to uv coordinates of faces.

Exceptions

Exception Condition
Autodesk.Revit.Exceptions ArgumentNullException A non-optional argument was NULL
Autodesk.Revit.Exceptions ArgumentOutOfRangeException A value passed for an enumeration argument is not a member of that enumeration
Autodesk.Revit.Exceptions InvalidOperationException This operation is valid only for vertically compound structures.

See Also