CATGSMUseItf Interface CATIGSMUseSpline

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

interface CATIGSMUseSpline

Spline feature.
Role:Allows to access data of the spline feature.

See also:

Method Index


o Add(CATIMmiMechanicalFeature_var)
Adds a point to the spline.
o AddCurvatureRadiusDirection(CATIGSMUseDirection_var&,int)
Adds Curvature Radius Direction (norme is not use) for each point of the spline.
o AddTangentDirection(CATIGSMUseDirection_var&,int)
Adds tangent Direction (norme is not use) for each point of the spline .
o GetClosure(int&)
Gets whether the curve is closed.
o GetConstraintType(CATIGSMUseConstraintType&,int)
Gets the type of a constraint at a given position of the spline.
o GetCurvatureRadiusDirection(CATIGSMUseDirection_var&,int)
Gets Curvature Radius Direction (norme is not use) for each point of the spline.
o GetCurvatureRadiusValue(CATICkeParm_var&,int)
Gets Curvature Radius Value for each point of the spline.
o GetCurveConstraint(CATIMmiMechanicalFeature_var&,int)
Gets curve specifiying a tangent or curvature constraint at a given position of the spline.
o GetCurveConstraintType(CATIGSMUseConstraintFromCurveType&,int)
Gets the type of a constraint specified by a curve at a given position of the spline.
o GetDirectionInversion(int&,int)
Gets the orientation of the tangent direction .
o GetPointAtPosition(CATIMmiMechanicalFeature_var&,int)
Gets the point which is at the given position.
o GetPosition(CATIMmiMechanicalFeature_var,int&)
Gets the position of an element in the list.
o GetSemiClosure(CATIMmiMechanicalFeature_var&)
Gets the semi-closure point of the closed spline.
o GetSize(int&)
Gets the size of the list (number of points).
o GetSplineType(CATIGSMUseSplineType&)
Gets the spline type.
o GetSupport(CATIMmiMechanicalFeature_var&)
Gets the support surface.
o GetTangentDirection(CATIGSMUseDirection_var&,int)
Gets tangent Direction (norme is not use) for each point of the spline.
o GetTangentNorm(CATICkeParm_var&,int)
Gets the Tension (Tangent Norme) for each point of the spline.
o InsertAfterPosition(CATIMmiMechanicalFeature_var,int)
Inserts a point after another at a given position.
o InsertBeforePosition(CATIMmiMechanicalFeature_var,int)
Inserts a point before another at a given position.
o InvertDirection(int)
Inverts the orientation of the tangent direction .
o RemoveAll()
Removes all elements in the list of points.
o RemoveCurvatureRadiusDirection(int)
Removes Curvature Radius Direction (norme is not use) for each point of the spline.
o RemoveCurvatureRadiusValue(int)
Removes Curvature Radius Value for each point of the spline.
o RemoveCurveConstraint(int)
Removes curve specifiying a tangent or curvature constraint at a given position of the spline.
o RemovePointAtPosition(int)
Removes the points at the given position.
o RemoveSupport()
Removes the support surface.
o RemoveTangentDirection(int)
Removes tangent Direction (norme is not use) for each point of the spline.
o RemoveTangentNorm(int)
Removes the Tension (Tangent Norme) for each point of the spline.
o ReplacePointAtPosition(CATIMmiMechanicalFeature_var&,int)
Replaces a point in the list at the given position.
o SetClosure(int)
Sets whether the curve is closed.
o SetCurvatureRadiusValue(CATICkeParm_var&,int)
Sets Curvature Radius Value for each point of the spline.
o SetCurveConstraint(CATIMmiMechanicalFeature_var,int)
Sets curve specifying a tangent or curvature constraint at a given position of the spline.
o SetCurveConstraintType(CATIGSMUseConstraintFromCurveType,int)
Sets the type of a constraint specified by a curve at a given position of the spline.
o SetSemiClosure(CATIMmiMechanicalFeature_var)
Sets the semi-closure point of the closed spline.
o SetSplineType(CATIGSMUseSplineType)
Sets the spline type.
o SetSupport(CATIMmiMechanicalFeature_var)
Sets the support surface.
o SetTangentNorm(CATICkeParm_var&,int)
Sets the Tension (Tangent Norme) for each point of the spline.

Enumerated Type Index


o CATIGSMUseConstraintFromCurveType
Different kinds of constraint specified by a curve.
o CATIGSMUseConstraintType
Different kinds of constraint specified at a given position of the spline.
o CATIGSMUseSplineType
Different kinds of spline.

Methods


o Add
public virtual Add( const iPoint)
Adds a point to the spline. The point is added at the end of the list.
Parameters:
iPoint
Point
o AddCurvatureRadiusDirection
public virtual AddCurvatureRadiusDirection( const iCrDir,
iPos)
Adds Curvature Radius Direction (norme is not use) for each point of the spline. A tangent direction AND Norm are Necessary First Position is 1 Position 0 return E_FAIL
Parameters:
iCrDir
Curvature radius
iPos
Position of point in spline
See also:
o AddTangentDirection
public virtual AddTangentDirection( const iTgtDir,
iPos)
Adds tangent Direction (norme is not use) for each point of the spline . First Position is 1 Position 0 return E_FAIL
Parameters:
iTgtDir
Tangent direction
iPos
Position of point in spline
See also:
o GetClosure
public virtual GetClosure( oClosed)
Gets whether the curve is closed.
Parameters:
oClosed
Closing flag
1
for a closed curve
0
for an open curve
o GetConstraintType
public virtual GetConstraintType( oType,
iPos)
Gets the type of a constraint at a given position of the spline.
Parameters:
oType
Constraint type (explicit or specified from curve)
iPos
Position of point in spline
o GetCurvatureRadiusDirection
public virtual GetCurvatureRadiusDirection( oCrDir,
iPos)
Gets Curvature Radius Direction (norme is not use) for each point of the spline. A tangent direction AND Norm are Necessary First Position is 1 Position 0 return E_FAIL
Parameters:
oCrDir
Curvature radius
iPos
Position of point in spline
See also:
o GetCurvatureRadiusValue
public virtual GetCurvatureRadiusValue( oCrVal,
iPos)
Gets Curvature Radius Value for each point of the spline. A tangent direction AND Norm are Necessary A Curvature Radius Direction is Necessary First Position is 1 Position 0 return E_FAIL
Parameters:
oCrVal
Curvature value
iPos
Position of point in spline
See also:
o GetCurveConstraint
public virtual GetCurveConstraint( oCrv,
iPos)
Gets curve specifiying a tangent or curvature constraint at a given position of the spline.
Parameters:
oCrv
Curve
iPos
Position of point in spline
o GetCurveConstraintType
public virtual GetCurveConstraintType( oType,
iPos)
Gets the type of a constraint specified by a curve at a given position of the spline.
Parameters:
oType
Constraint from curve type
iPos
Position of point in spline
o GetDirectionInversion
public virtual GetDirectionInversion( oInvertFlag,
iPos)
Gets the orientation of the tangent direction . Value iPos First Position is 1 Position 0 return E_FAIL
Parameters:
oInvertFlag
invert flag = 1 No Inversion = -1 Invert
iPos
Position of point in spline
o GetPointAtPosition
public virtual GetPointAtPosition( oPoint,
iPos)
Gets the point which is at the given position. First Position is 1 Position 0 return E_FAIL
Parameters:
oPoint
Point
iPos
Insert position
o GetPosition
public virtual GetPosition( const iPoint,
oPos)
Gets the position of an element in the list.
Parameters:
iPoint
Point
oPos
position in spline
o GetSemiClosure
public virtual GetSemiClosure( oPoint)
Gets the semi-closure point of the closed spline.
Parameters:
oPoint
Semi-closure point
o GetSize
public virtual GetSize( oSize)
Gets the size of the list (number of points).
Parameters:
oSize
number of points
o GetSplineType
public virtual GetSplineType( oType)
Gets the spline type.
Parameters:
oType
Spline Type
o GetSupport
public virtual GetSupport( oSupport)
Gets the support surface.
Parameters:
oSupport
Supporting surface for spline (if exist)
o GetTangentDirection
public virtual GetTangentDirection( oTgtDir,
iPos)
Gets tangent Direction (norme is not use) for each point of the spline. First Position is 1 Position 0 return E_FAIL
Parameters:
iTgtDir
Tangent direction
iPos
Position of point in spline
See also:
o GetTangentNorm
public virtual GetTangentNorm( oTgtNm,
iPos)
Gets the Tension (Tangent Norme) for each point of the spline. A tangent direction is necessary First Position is 1 Position 0 return E_FAIL
Parameters:
oTgtNm
Tension
iPos
Position of point in spline
See also:
o InsertAfterPosition
public virtual InsertAfterPosition( const iPoint,
iPos)
Inserts a point after another at a given position. First Position is 1
  • InsertAfterPosition(MyPoint,0) Add at the begining of the spline
  • InsertAfterPosition(MyPoint,SplineSize) Add at the end of the spline
    • Parameters:
    iPoint
    Point
    iPos
    Insert after position
    o InsertBeforePosition
    public virtual InsertBeforePosition( const iPoint,
    iPos)
    Inserts a point before another at a given position.
    Parameters:
    iPoint
    Point
    iPos
    Insert before position
    o InvertDirection
    public virtual InvertDirection( iPos)
    Inverts the orientation of the tangent direction .
    Parameters:
    iPos
    First Position is 1 Position 0 return E_FAIL
    Returns:
    S_OK if OK, E_FAIL if fail
    o RemoveAll
    public virtual RemoveAll()
    Removes all elements in the list of points.
    o RemoveCurvatureRadiusDirection
    public virtual RemoveCurvatureRadiusDirection( iPos)
    Removes Curvature Radius Direction (norme is not use) for each point of the spline. A tangent direction AND Radius are Necessary First Position is 1 Position 0 return E_FAIL
    Parameters:
    iPos
    Position of point in spline
    o RemoveCurvatureRadiusValue
    public virtual RemoveCurvatureRadiusValue( iPos)
    Removes Curvature Radius Value for each point of the spline. A tangent direction AND Norm is Necessary A Curvature Radius Direction is Necessary First Position is 1 Position 0 return E_FAIL
    Parameters:
    iPos
    Position of point in spline
    o RemoveCurveConstraint
    public virtual RemoveCurveConstraint( iPos)
    Removes curve specifiying a tangent or curvature constraint at a given position of the spline.
    Parameters:
    iPos
    Position of point in spline
    o RemovePointAtPosition
    public virtual RemovePointAtPosition( iPos)
    Removes the points at the given position.
    Parameters:
    iPos
    Insert position
    o RemoveSupport
    public virtual RemoveSupport()
    Removes the support surface.
    o RemoveTangentDirection
    public virtual RemoveTangentDirection( iPos)
    Removes tangent Direction (norme is not use) for each point of the spline. First Position is 1 Position 0 return E_FAIL
    Parameters:
    iPos
    Position of point in spline
    o RemoveTangentNorm
    public virtual RemoveTangentNorm( iPos)
    Removes the Tension (Tangent Norme) for each point of the spline. A tangent direction is necessary First Position is 1 Position 0 return E_FAIL
    Parameters:
    iPos
    Position of point in spline
    o ReplacePointAtPosition
    public virtual ReplacePointAtPosition( oPoint,
    iPos)
    Replaces a point in the list at the given position.
    Parameters:
    oPoint
    Point
    iPos
    Replace position
    o SetClosure
    public virtual SetClosure( iClosed)
    Sets whether the curve is closed.
    Parameters:
    iClosed
    Closing flag
    1
    for a closed curve
    0
    for an open curve
    o SetCurvatureRadiusValue
    public virtual SetCurvatureRadiusValue( const iCrVal,
    iPos)
    Sets Curvature Radius Value for each point of the spline. A tangent direction AND Norm are Necessary A Curvature Radius Direction is Necessary First Position is 1 Position 0 return E_FAIL
    Parameters:
    iCrVal
    Curvature value
    iPos
    Position of point in spline
    See also:
    o SetCurveConstraint
    public virtual SetCurveConstraint( const iCrv,
    iPos)
    Sets curve specifying a tangent or curvature constraint at a given position of the spline.
    Parameters:
    iCrv
    Curve
    iPos
    Position of point in spline
    o SetCurveConstraintType
    public virtual SetCurveConstraintType( const iType,
    iPos)
    Sets the type of a constraint specified by a curve at a given position of the spline.
    Parameters:
    iType
    Constraint from curve Type
    iPos
    Position of point in spline
    o SetSemiClosure
    public virtual SetSemiClosure( const iPoint)
    Sets the semi-closure point of the closed spline.
    Parameters:
    iPoint
    Semi-closure point
    o SetSplineType
    public virtual SetSplineType( const iType)
    Sets the spline type.
    Parameters:
    iType
    Set spline Type
    o SetSupport
    public virtual SetSupport( const iSupport)
    Sets the support surface. With support we recommand to have your "tangent direction" tangent to this support
    Parameters:
    iSupport
    Set Supporting surface for spline (if exist)
    o SetTangentNorm
    public virtual SetTangentNorm( const iTgtNm,
    iPos)
    Sets the Tension (Tangent Norme) for each point of the spline. A tangent direction is necessary First Position is 1 Position 0 return E_FAIL
    Parameters:
    iTgtNm
    Tension
    iPos
    Position of point in spline
    See also:

    Enumerated Types


    o CATIGSMUseConstraintFromCurveType 
    enum CATIGSMUseConstraintFromCurveType {
  Tangency,
  Curvature
}
    Different kinds of constraint specified by a curve.
    Parameters:
    Tangency
    Tangency continuity
    Curvature
    Curvature continuity
    o CATIGSMUseConstraintType 
    enum CATIGSMUseConstraintType {
  GSMSpline_None,
  GSMSpline_Explicit,
  GSMSpline_FromCurve
}
    Different kinds of constraint specified at a given position of the spline.
    Parameters:
    None
    No constraint is specified
    Explicit
    Constraint specified by a tangent direction, a tangent norm (tension parameter), a curvature direction, a curvature radius.
    From
    curve Constraint (tangency or curvature) specified by a curve and a tension parameter.
    o CATIGSMUseSplineType 
    enum CATIGSMUseSplineType {
  Cubic,
  WilsonFowler
}
    Different kinds of spline.
    Parameters:
    Cubic
    Cubic spline
    WilsonFowler
    WilsonFowler spline
    This object is included in the file: CATIGSMUseSpline.h
    If needed, your Imakefile.mk should include the module: CATGSMUseItf

    Copyright © 1999-2014, Dassault Systèmes. All rights reserved.