All Frameworks Class Hierarchy This Framework Indexes Previous Next

ElecFlatteningItf Interface CATIEhfUIPArrangeJunction

Usage: you can freely reimplement this interface.

interface CATIEhfUIPArrangeJunction

This Interface CATIEhfUIPArrangeJunction allows “Arrange Junction – User Pattern” command to be implemented by user for the definition of his own branch arrangement rules.
Interface must be implemented on component CAAEhfArrangeJunction by extending the component.

Method Index

o RetrieveUserDirection(CATListPtrCATBaseUnknown&,CATMathPlane&,CATLISTP(CATMathVector)&): User has to provide the implementation for this method when he implements this interface on CAAEhfArrangeJunction component.

Methods

o RetrieveUserDirection

public virtual RetrieveUserDirection(	const	`iListOfBundleSegmentExtremity`,
	const	`iFlatteningPlane`,
		`ioListOfDirections`)

User has to provide the implementation for this method when he implements this interface on CAAEhfArrangeJunction component. This method takes input as connected bundle segment extremities at the junction and tangent of bundle segment selected to remain fixed by user. The input bundle segment extremities list is ordered in clock-wise angular fashion with respect to the normal to Flatten Plane selected in Flattening Parameters. In case of user has selected fixed bundle segment having a branch point as the selected junction, tangents of both bundle segments of the branch will be input. Please refer PES of "Arrange Junction" command for further details. Location of header files for argument types in frameworks: For CATListPtrCATBaseUnknown type: Application\PublicInterfaces. For CATMathPlane, CATMathVector and CATLISTP_CATMathVector types: Mathematics\PublicInterfaces.

Parameters:

iListOfBundleSegmentExtremity: (Input): List of CATBaseUnknown pointers of bundle segment extremities at the selected junction
iFlatteningPlane: (Input): Active plane in Flattening Parameters. User is supposed to have flattened the model on this plane. Programmer can use this plane to calculate the rotated vectors
ioListOfDirections: (Input and Output): List of CATMathVector pointers. The type is found in header file CATLISTP_CATMathVector.h. If the vector in the list is valuated in Input, then it is considered as the main direction. For other vector pointers, the implementation must put a value as Output

Returns:

An HRESULT value
Legal values:

S_OK: Method is successful
E_FAIL: Method Failed

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