All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATArrangementInterfaces Interface CATIArrSegment

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIArrSegment
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIArrSegment

Interface to the Segment subobject of SegmentsStrings.
Role: The segments define the path of a SegmentsString. Related nodes define the start and end limits of this segment (the nodes are constrained by their related segments). A related Section (optoinal) defines the cross sectional shape of this segment. This segment has a required line connector defining the support line, and optional line connectors defining the derived lines are the Section SetPoints.


Method Index


o GetCenterLine(CATIMovable_var&,CATMathLine&)
Retrieve the line geometry for the centerline of this segment.
o GetLimitedCenterLine(CATIMovable_var&,CATMathLine&)
Retrieve center line geometry (limited by adjacent center lines or extremity nodes) as a CATMathLine in the forward direction of the SegmentsString containing this segment, described in a CATIMovable relative axis.
o GetNodes(CATIArrNode_var&,CATIArrNode_var&)
Retrieve nodes at start and end of this segment.
o GetOrientationPlane(CATIMovable_var&,CATMathPlane&)
Retrieve the orientation plane geometry.
o GetSectionSetPoint(CATRouSetPointNames&)
Retrieves the SetPoint name.
o GetString(CATIArrSegmentsString_var&)
Get SegmentString for this object.
o GetSupportLine(CATIMovable_var&,CATMathLine&)
Retrieve the support line geometry.
o GetTurnLimitedCenterLine(CATIMovable_var&,CATMathLine&,CATMathPointf[],CATMathDirectionf[],float[],CATMathDirectionf[],float[],float[])
Retrieve center line geometry (limited by adjacent bends) as a CATMathLine in the forward direction of the SegmentsString containing this segment, described in a CATIMovable relative axis (KO if no bends): Also outputs parameters to create 2 CAT3DArcCircleRep arcs representing the bend center line arcs.
o GetTurnLimitedSupportLine(CATIMovable_var&,CATMathLine&,CATMathPointf[],CATMathDirectionf[],float[],CATMathDirectionf[],float[],float[])
Retrieve support line geometry (limited by adjacent bends) as a CATMathLine in the forward direction of the SegmentsString containing this segment, described in a CATIMovable relative axis (KO if no bends): Also outputs parameters to create 2 CAT3DArcCircleRep arcs representing the bend support line arcs.
o ListParams(CATCkeListOf(Parm)&)
ListParams.

Methods


o GetCenterLine
public virtual HRESULT GetCenterLine( const CATIMovable_var& ihRelAxis,
CATMathLine& oLine)= 0
Retrieve the line geometry for the centerline of this segment.
Parameters:
ihRelAxis
The relative axis object for the geometry (NULL_var means relative to parent).
oLine
The geometric line at the section centerline.
o GetLimitedCenterLine
public virtual HRESULT GetLimitedCenterLine( const CATIMovable_var& ihRelAxis,
CATMathLine& oLine)= 0
Retrieve center line geometry (limited by adjacent center lines or extremity nodes) as a CATMathLine in the forward direction of the SegmentsString containing this segment, described in a CATIMovable relative axis.
Parameters:
ihRelAxis
The relative axis object for the geometry (NULL_var means relative to parent).
oLine
The geometric argument as CATMathLine where the 0.0 and 1.0 parameters are at the ends of the LimitedCenterLine.
o GetNodes
public virtual HRESULT GetNodes(CATIArrNode_var& ohNode1,
CATIArrNode_var& ohNode2)= 0
Retrieve nodes at start and end of this segment.
Parameters:
ohNode1
Node at start of this segment (NULL_var if none).
ohNode2
Node at end of this segment (NULL_var if none).
o GetOrientationPlane
public virtual HRESULT GetOrientationPlane( const CATIMovable_var& ihRelAxis,
CATMathPlane& oPlane)= 0
Retrieve the orientation plane geometry.
Parameters:
ihRelAxis
The relative axis object for the geometry (NULL_var means relative to parent).
oPlane
The geometric argument as CATMathPlane.
o GetSectionSetPoint
public virtual HRESULT GetSectionSetPoint(CATRouSetPointNames& oPointName)= 0
Retrieves the SetPoint name.
Parameters:
oPointName
The current SetPoint name.
o GetString
public virtual HRESULT GetString(CATIArrSegmentsString_var& oArrString)= 0
Get SegmentString for this object.
Parameters:
oArrString
CATIArrSegmentsString.
o GetSupportLine
public virtual HRESULT GetSupportLine( const CATIMovable_var& ihRelAxis,
CATMathLine& oLine)= 0
Retrieve the support line geometry.
Parameters:
ihRelAxis
The relative axis object for the geometry (NULL_var means relative to parent).
oLine
The geometric line.
o GetTurnLimitedCenterLine
public virtual HRESULT GetTurnLimitedCenterLine( const CATIMovable_var& ihRelAxis,
CATMathLine& oLine,
CATMathPointf[] oArcCentr,
CATMathDirectionf[] oArcNormal,
float[] oArcRadius,
CATMathDirectionf[] oArc0Axis,
float[] oBegAng,
float[] oEndAng)= 0
Retrieve center line geometry (limited by adjacent bends) as a CATMathLine in the forward direction of the SegmentsString containing this segment, described in a CATIMovable relative axis (KO if no bends): Also outputs parameters to create 2 CAT3DArcCircleRep arcs representing the bend center line arcs.
Parameters:
ihRelAxis
The relative axis object for the geometry (NULL_var means relative to parent).
oLine
The geometric argument as CATMathLine where the 0.0 and 1.0 parameters are at the ends of the LimitedCenterLine.
oArcCentr[]
The center points of the 2 circles
oArcNormal[]
The normal directions of the 2 circles
oArcRadius[]
The radii of the 2 circles
oArc0Axis[]
The 0 degree axis direction of the 2 circles
oBegAng[]
The begin angles of the 2 circles
oEndAng[]
The end angles of the 2 circles
o GetTurnLimitedSupportLine
public virtual HRESULT GetTurnLimitedSupportLine( const CATIMovable_var& ihRelAxis,
CATMathLine& oLine,
CATMathPointf[] oArcCentr,
CATMathDirectionf[] oArcNormal,
float[] oArcRadius,
CATMathDirectionf[] oArc0Axis,
float[] oBegAng,
float[] oEndAng)= 0
Retrieve support line geometry (limited by adjacent bends) as a CATMathLine in the forward direction of the SegmentsString containing this segment, described in a CATIMovable relative axis (KO if no bends): Also outputs parameters to create 2 CAT3DArcCircleRep arcs representing the bend support line arcs.
Parameters:
ihRelAxis
The relative axis object for the geometry (NULL_var means relative to parent).
oLine
The geometric argument as CATMathLine where the 0.0 and 1.0 parameters are at the ends of the LimitedSupportLine.
oArcCentr[]
The center points of the 2 circles
oArcNormal[]
The normal directions of the 2 circles
oArcRadius[]
The radii of the 2 circles
oArc0Axis[]
The 0 degree axis direction of the 2 circles
oBegAng[]
The begin angles of the 2 circles
oEndAng[]
The end angles of the 2 circles
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: CATIArrSegment.h
If needed, your Imakefile.mk should include the module: CATArrangementItf

Copyright © 2003, Dassault Systèmes. All rights reserved.