All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATArrangementInterfaces Interface CATIArrNode
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIArrNode
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIArrNode
Interface on Nodes of a Segment .
Role: To get the node, segment data.
Method Index
- o
CalculateAngle(CATAngle&,CATRouNodeGeomStatus&)
- CalculateAngle.
- o
GetBendRadius(double&)
- GetBendRadius.
- o
GetBendRuleData(int&,int&,double&,CATUnicodeString&)
- GetBendRuleData.
- o
GetCenterLinePoint(CATIMovable_var&,CATMathPoint&,CATMathPoint&,CATRouNodeGeomStatus&)
- GetCenterLinePoint.
- o
GetPoint(CATIMovable_var&,CATMathPoint&)
- Retrieve geometry as CATMathPoint, described in a CATIMovable relative axis.
- o
GetSegments(CATIArrSegment_var&,CATIArrSegment_var&)
- Get Segments in this string connected at this node.
- o
GetString(CATIArrSegmentsString_var&)
- Get SegmentString for this object.
- o
IsBroken(CATBoolean&)
- Query if a node is broken(not buildable).
- o
IsExtremity(CATBoolean&)
- Query if this is a extremity node.
- o
ListParams(CATCkeListOf(Parm)&)
- ListParams.
Methods
o CalculateAngle
-
CalculateAngle.
- Parameters:
-
- oAngleDegree
- CATAngle turn from previous Segment to next Segment.
- oStatus
- See CATRouNodeGeomStatus.h for SupportLine/CenterLine intersect values.
o GetBendRadius
public virtual HRESULT GetBendRadius( | double& | oBendRadius)= 0 |
-
GetBendRadius. Will return the default value of 0.0 if param doesn't exist.
- Returns:
- double
o GetBendRuleData
public virtual HRESULT GetBendRuleData( | int& | oUseRule, |
| int& | oBendNumberOfMiter, |
| double& | oBendDiamFactor, |
| CATUnicodeString& | oBendPartType)= 0 |
-
GetBendRuleData. Will retrieve the turn data based on rule used.
- Parameters:
-
- oUseRule
- =0 override. This is the mode for ALL spatial routing
=1 rules were used
- oBendNumberOfMiter
- number of miters for this turn
- oBendDiamFactor
- a multiplier to apply to the bend diameter
- oBendPartType
- =NULL string: use turn radius
=non-NULL: use the part type defined in this string e.g. ELBOW.
o GetCenterLinePoint
-
GetCenterLinePoint.
- Parameters:
-
- ihRelAxis
- The relative axis object (NULL_var means relative to parent).
- oPoint1
- IF CenterLines intersect
CATMathPoint at intersection of previous and next centerlines.
ELSE
CATMathPoint of node projected onto previous CenterLine.
- oPoint2
- IF CenterLines intersect
CATMathPoint equal to oPoint1.
ELSE
CATMathPoint of node projected onto next CenterLine.
- oStatus
- See CATRouNodeGeomStatus.h for SupportLine/CenterLine intersect values.
o GetPoint
-
Retrieve geometry as CATMathPoint, described in a CATIMovable relative axis.
- Parameters:
-
- ihRelAxis
- The relative axis object (NULL_var means relative to parent).
- oPoint
- The geometric argument as CATMathPoint.
o GetSegments
public virtual HRESULT GetSegments( | CATIArrSegment_var& | oSegment1, |
| CATIArrSegment_var& | oSegment2)= 0 |
-
Get Segments in this string connected at this node.
- Parameters:
-
- oSegment1
-
- oSegment2
o GetString
public virtual HRESULT GetString( | CATIArrSegmentsString_var& | oArrString)= 0 |
-
Get SegmentString for this object.
- Parameters:
-
- oArrString
- CATIArrSegmentsString.
o IsBroken
-
Query if a node is broken(not buildable).
- Returns:
- CATBoolean.
o IsExtremity
-
Query if this is a extremity node.
- Returns:
- CATBoolean.
o ListParams
public virtual HRESULT ListParams( | CATCkeListOf(Parm)& | oListParams)= 0 |
-
ListParams.
- Parameters:
-
- oListParams
- A list of CKE parameters.
This object is included in the file: CATIArrNode.h
If needed, your Imakefile.mk should include the module: CATArrangementItf