All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMOperatorsInterfaces class CATICGMTopBlend

CATICGMTopBlend

Usage: you must use this class as is. You should never derive it.

public class CATICGMTopBlend

Class defining the topological operator that connects two wires with a skin.

Continuity criteria can be precised: G0, G1 or G2 if the supporting surfaces of the wires are given, G0 otherwise.
The CATICGMTopBlend operator creates the resulting blend separately from the inputs: the topology of the input bodies is not used to define the topology of the resulting body.

A CATICGMTopBlend operator is created with the CATCGMCreateTopBlend global method; it must be directly released with the Release method after use. It is is not streamable.
Options can be precised with the SetXxx methods, before asking for the computation with the Run method.
The resulting body is retrieved with the GetResult method.

Constructor and Destructor Index

o CATICGMTopBlend(): Constructor

Method Index

o GetDefaultTransitionOrientation(int): Retrieves the default TransitionOrientation defined by this operator.
o GetDefaultWireOrientation(int): Retrieves the default WireOrientation defined by this operator.
o GetTransitionOrientation(int): Get the TransitionOrientation used by this operator.
o GetWireOrientation(int): Returns the orientation of the wire used by this operator.
o SetBorderMode(int,int,int): Specifies where the blend boundaries are to be tangent to the support boundaries.
o SetCleanGuidesOption(CATLONG32,double*,double*,double*): Defines clean guides option, and clean parameter values.
o SetCouplingLines(CATLISTP(CATGeometry)*): Defines coupling lines.
o SetCouplingMode(CATTopBlendCouplingMode): Defines the coupling mode.
o SetLayDownRequest(double*): Asks for topological lay down to be done internally for all guides with support surfaces.
o SetSmoothAngleThreshold(double): Defines the smooth angle threshold.
o SetSmoothOption(CATLONG32): Defines a smooth option for moving frame, coupling and comb extraction.
o SetTransitionContinuity(int,int): Defines the continuity criteria to take into account for a given wire (ADVANCED mode).
o SetTransitionOrientation(int,int): Set the TransitionOrientation used by this operator.
o SetWireOrientation(int,int): Defines the orientation of the wire to be used by this operator(ADVANCED mode).

Constructor and Destructor

o CATICGMTopBlend

public CATICGMTopBlend(

)

Constructor

Methods

o GetDefaultTransitionOrientation

public virtual int GetDefaultTransitionOrientation( int iWhichWire) = 0

Retrieves the default TransitionOrientation defined by this operator.
The operator does an analysis of the inputs, in order to avoid twisted surfaces for examples. This method returns the orientation found after this analysis.

Parameters:

iWhichWire: The first (1) or the second (2) input wire.

Returns:

The default transition orientation.
Legal values: 1 the direction of oTransitionOrientationSide*(T^N) iWhichWire wire is used, -1 for the opposite orientation.

o GetDefaultWireOrientation

public virtual int GetDefaultWireOrientation( int iWhichWire) = 0

Retrieves the default WireOrientation defined by this operator.
The operator does an analysis of the inputs, in order to avoid twisted surfaces for examples. This method returns the orientation found after this analysis.

Parameters:

iWhichWire: The first (1) or the second (2) input wire.

Returns:

The default wire orientation.
Legal values: 1 the natural orientation of the iWhichWire wire is used, -1 for the opposite orientation.

o GetTransitionOrientation

public virtual int GetTransitionOrientation( int iWhichWire) = 0

Get the TransitionOrientation used by this operator.

Parameters:

iWhichWire: The first (1) or the second (2) input wire.

Returns:

The transition orientation.
Legal values: 1 the direction of oTransitionOrientationSide*(T^N) iWhichWire wire is used, -1 for the opposite orientation.

o GetWireOrientation

public virtual int GetWireOrientation( int iWhichWire) = 0

Returns the orientation of the wire used by this operator.

Parameters:

iWhichWire: The first (1) or the second (2) input wire.

Returns:

The orientation.
Legal values: 1 the natural orientation of the iWhichWire wire is used, -1 for the opposite orientation.

o SetBorderMode

public virtual void SetBorderMode(	int	`iWhichWire`,
	int	`StartEnd`,
	int	`iMode`	`= 1`) = 0

Specifies where the blend boundaries are to be tangent to the support boundaries.
Warning: This method is inoperative when the wires to be connected are not layed down onto their supports. To lay down the wires onto their supports, you must use either the CATICGMHybProject or CATICGMLayDownOperator operators.

Parameters:

iWhichWire

The first (1) or the second (2) input wire. If the coupling mode is set to CATTopBlendCouplingMode_Develop, iWhichWire is the guide number whose extremity vertex relimits the coupling (the extremity on the other guide is free).

StartEnd

The start (1) or the end (2) extremity where the border mode is to be applied.

iMode

1: tangent mode.
2: normal mode.

If the coupling mode is set to CATTopBlendCouplingMode_Develop:

0: until extremity vertices on all guides.
1: until extremity vertex of iWhichWire.
2: the best solution.

o SetCleanGuidesOption

public virtual void SetCleanGuidesOption(	CATLONG32	`iCleanOption`	`= 0`,
	double*	`iCleanMaxDeformation`	`= NULL`,
	double*	`iCleanSmallCurvesMaxLength`	`= NULL`,
	double*	`iCleanCurvatureThreshold`	`= NULL`) = 0

Defines clean guides option, and clean parameter values. Pointers to parameter values are to be given only when corresponding parameter is redefined, otherwise, standard parameter value will be used. Pointers may contain addresses of local variables that will be lost after call: parameter values will be copied by this method.

Parameters:

iCleanOption: The cleaning option
Legal values: 0 no cleaning will be done (default mode at operator creation), 1 cleaning will be done.
iCleanMaxDeformation: The pointer to max deformation authorized.
iCleanSmallCurvesMaxLength: The pointer to maximum length of curves to be kept.
iCleanCurvatureThreshold: The pointer to the curvature threshold.

o SetCouplingLines

public virtual void SetCouplingLines( CATLISTP(CATGeometry)* iCouplingLines) = 0

Defines coupling lines.

Parameters:

iCouplingLines: The list of pointers to the coupling lines (wire bodies).

o SetCouplingMode

public virtual void SetCouplingMode( CATTopBlendCouplingMode iMode) = 0

Defines the coupling mode.

Parameters:

iMode: The coupling mode.

o SetLayDownRequest

public virtual void SetLayDownRequest( double* iLayDownTolerance = NULL) = 0

Asks for topological lay down to be done internally for all guides with support surfaces.

Parameters:

iLayDownTolerance: The pointer to the lay down tolerance (maximum distance between wire to be laid down and its support surface).

o SetSmoothAngleThreshold

public virtual void SetSmoothAngleThreshold( double iAngleThreshold) = 0

Defines the smooth angle threshold.

Parameters:

iSmoothAngleThreshold: The threshold for smooth (in radian); any angle below this value will be smoothed if smooth option has been activated by SetSmoothOption method.

o SetSmoothOption

public virtual void SetSmoothOption( CATLONG32 iSmoothOption = 1) = 0

Defines a smooth option for moving frame, coupling and comb extraction.

Parameters:

iSmoothOption: The smoothing option
Legal values: 0 no smoothing will be done 1 smoothing will be done. (default mode at operator creation),

o SetTransitionContinuity

public virtual void SetTransitionContinuity(	int	`iWhichWire`,
	int	`iTransitionContinuity`) = 0

Defines the continuity criteria to take into account for a given wire (ADVANCED mode).

Parameters:

iWhichWire: The first (1) or the second (2) input wire.
iTransitionContinuity: The continuity criteria.
Legal values: 0 for G0 continuity, 1 for G1 continuity, 2 for G2 continuity.

o SetTransitionOrientation

public virtual void SetTransitionOrientation(	int	`iWhichWire`,
	int	`TransitionOrientation`) = 0

Set the TransitionOrientation used by this operator. Let T be the tangent to the wire, and N be the normal to the skin body. The transition orientation defines how the blend goes from the initial wires: it takes the direction of oTransitionOrientationSide*(T^N), where ^ is the vectorial product.

Parameters:

iWhichWire: The first (1) or the second (2) input wire.
TransitionOrientation: The transition orientation.
Legal values: 1 the direction of oTransitionOrientationSide*(T^N) iWhichWire wire is used, -1 for the opposite orientation.

o SetWireOrientation

public virtual void SetWireOrientation(	int	`iWhichWire`,
	int	`iWireOrientation`) = 0

Defines the orientation of the wire to be used by this operator(ADVANCED mode).

Parameters:

iWhichWire: The first (1) or the second (2) input wire.
iWireOrientation: The orientation.
Legal values: 1 the natural orientation of the iWhichWire wire is used, -1 for the opposite orientation.

This object is included in the file: CATICGMTopBlend.h
If needed, your Imakefile.mk should include the module: CATGMOperatorsInterfaces

GMOperatorsInterfaces writeClassCharacteristic(); class CATICGMTopBlend

Constructor and Destructor Index

Method Index

Constructor and Destructor

Methods

GMOperatorsInterfaces class CATICGMTopBlend