Open CASCADE Technology  7.7.0.dev
Public Member Functions | Protected Attributes

AppDef_MultiLine Class Reference

This class describes the organized set of points used in the approximations. A MultiLine is composed of n MultiPointConstraints. The approximation of the MultiLine will be done in the order of the given n MultiPointConstraints. More...

#include <AppDef_MultiLine.hxx>

Public Member Functions

 AppDef_MultiLine ()
 creates an undefined MultiLine. More...
 
 AppDef_MultiLine (const Standard_Integer NbMult)
 given the number NbMult of MultiPointConstraints of this MultiLine , it initializes all the fields.SetValue must be called in order for the values of the multipoint constraint to be taken into account. An exception is raised if NbMult < 0. More...
 
 AppDef_MultiLine (const AppDef_Array1OfMultiPointConstraint &tabMultiP)
 Constructs a MultiLine with an array of MultiPointConstraints. More...
 
 AppDef_MultiLine (const TColgp_Array1OfPnt &tabP3d)
 The MultiLine constructed will have one line of 3d points without their tangencies. More...
 
 AppDef_MultiLine (const TColgp_Array1OfPnt2d &tabP2d)
 The MultiLine constructed will have one line of 2d points without their tangencies. More...
 
Standard_Integer NbMultiPoints () const
 returns the number of MultiPointConstraints of the MultiLine. More...
 
Standard_Integer NbPoints () const
 returns the number of Points from MultiPoints composing the MultiLine. More...
 
void SetParameter (const Standard_Integer Index, const Standard_Real U)
 Sets the value of the parameter for the MultiPointConstraint at position Index. Exceptions. More...
 
void SetValue (const Standard_Integer Index, const AppDef_MultiPointConstraint &MPoint)
 It sets the MultiPointConstraint of range Index to the value MPoint. An exception is raised if Index < 0 or Index> MPoint. An exception is raised if the dimensions of the MultiPoints are different. More...
 
AppDef_MultiPointConstraint Value (const Standard_Integer Index) const
 returns the MultiPointConstraint of range Index An exception is raised if Index<0 or Index>MPoint. More...
 
void Dump (Standard_OStream &o) const
 Prints on the stream o information on the current state of the object. Is used to redefine the operator <<. More...
 

Protected Attributes

Handle< AppDef_HArray1OfMultiPointConstraint > tabMult
 

Detailed Description

This class describes the organized set of points used in the approximations. A MultiLine is composed of n MultiPointConstraints. The approximation of the MultiLine will be done in the order of the given n MultiPointConstraints.

Example of a MultiLine composed of MultiPointConstraints:

P1______P2_____P3______P4________........_____PNbMult

Q1______Q2_____Q3______Q4________........_____QNbMult . . . . . . R1______R2_____R3______R4________........_____RNbMult

Pi, Qi, ..., Ri are points of dimension 2 or 3.

(P1, Q1, ...R1), ...(Pn, Qn, ...Rn) n= 1,...NbMult are MultiPointConstraints. There are NbPoints points in each MultiPointConstraint.

Constructor & Destructor Documentation

◆ AppDef_MultiLine() [1/5]

AppDef_MultiLine::AppDef_MultiLine ( )

creates an undefined MultiLine.

◆ AppDef_MultiLine() [2/5]

AppDef_MultiLine::AppDef_MultiLine ( const Standard_Integer  NbMult)

given the number NbMult of MultiPointConstraints of this MultiLine , it initializes all the fields.SetValue must be called in order for the values of the multipoint constraint to be taken into account. An exception is raised if NbMult < 0.

◆ AppDef_MultiLine() [3/5]

AppDef_MultiLine::AppDef_MultiLine ( const AppDef_Array1OfMultiPointConstraint tabMultiP)

Constructs a MultiLine with an array of MultiPointConstraints.

◆ AppDef_MultiLine() [4/5]

AppDef_MultiLine::AppDef_MultiLine ( const TColgp_Array1OfPnt tabP3d)

The MultiLine constructed will have one line of 3d points without their tangencies.

◆ AppDef_MultiLine() [5/5]

AppDef_MultiLine::AppDef_MultiLine ( const TColgp_Array1OfPnt2d tabP2d)

The MultiLine constructed will have one line of 2d points without their tangencies.

Member Function Documentation

◆ Dump()

void AppDef_MultiLine::Dump ( Standard_OStream o) const

Prints on the stream o information on the current state of the object. Is used to redefine the operator <<.

◆ NbMultiPoints()

Standard_Integer AppDef_MultiLine::NbMultiPoints ( ) const

returns the number of MultiPointConstraints of the MultiLine.

◆ NbPoints()

Standard_Integer AppDef_MultiLine::NbPoints ( ) const

returns the number of Points from MultiPoints composing the MultiLine.

◆ SetParameter()

void AppDef_MultiLine::SetParameter ( const Standard_Integer  Index,
const Standard_Real  U 
)

Sets the value of the parameter for the MultiPointConstraint at position Index. Exceptions.

  • Standard_OutOfRange if Index is less than 0 or Index is greater than the number of Multipoint constraints in the MultiLine.

◆ SetValue()

void AppDef_MultiLine::SetValue ( const Standard_Integer  Index,
const AppDef_MultiPointConstraint MPoint 
)

It sets the MultiPointConstraint of range Index to the value MPoint. An exception is raised if Index < 0 or Index> MPoint. An exception is raised if the dimensions of the MultiPoints are different.

◆ Value()

AppDef_MultiPointConstraint AppDef_MultiLine::Value ( const Standard_Integer  Index) const

returns the MultiPointConstraint of range Index An exception is raised if Index<0 or Index>MPoint.

Field Documentation

◆ tabMult

Handle< AppDef_HArray1OfMultiPointConstraint > AppDef_MultiLine::tabMult
protected

The documentation for this class was generated from the following file: