All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATTPSUseItf Interface CATITPSFactoryAdvanced

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

interface CATITPSFactoryAdvanced

High level annotation factory interfaces.
The purpose of this interface is to encapsulate the generation of all features and even containers which are needed to create a 3D annotation. The 3D Annotations returned by the methods of this interface are fulfilled and self-suficient. They can be seen and manipulated interactively by the user.

Method Index

o CreateTextOnAnnotation(CATITPS*,CATUnicodeString*,CATITPSText**): Creates a Text annotation on another annotation.
o CreateTextOnGeometry(CATSO*,CATMathPlane*,CATUnicodeString*,CATITPSText**): Creates a Text annotation on a geometrical selection.
o CreateWeldOnGeometry(CATSO*,CATMathPlane*,CATITPSWeld**): Creates a Weld annotation on a geometrical selection.

Methods

o CreateTextOnAnnotation

public virtual CreateTextOnAnnotation(		`ipiTPS`,
		`ipString`,
		`opiCreatedText`)

Creates a Text annotation on another annotation. In part document using this method result in a status To Update for the part, this method does not manage part update.

Parameters:

ipiTPS: This argument define the annotation to which the created annotation will be grouped with.
ipString: A pointer on a valid CATUnicodeString.
opiCreatedText: The created Text.

Returns:

S_OK if succeded, E_FAIL if creation failed.

o CreateTextOnGeometry

public virtual CreateTextOnGeometry(		`ipGeometrySelected`,
		`ipPlane`,
		`ipString`,
		`opiCreatedText`)

Creates a Text annotation on a geometrical selection. In part document using this method result in a status To Update for the part, this method does not manage part update.

Parameters:

ipGeometrySelected: This argument define the geometry or feature to which the created annotation will apply to. This CATSO must contain at least a valid PathElement on a geometrical element or feature supported by 3D annotations. A valid PathElement means a PathElement identical to what is obtained by interactive selection. If there are several PathElement the text will apply on all the geometry selected.
ipPlane: Optionnal, can be used to specify a favorite plane for annotation 3D visualization. If NULL, annotation plane is automaticaly defined. If favorite plane is not convenient for annotation an other plane will be used and specified favorite plane will be ignored.
ipString: A pointer on a valid CATUnicodeString.
opiCreatedText: The created Text.

Returns:

S_OK if succeded, E_FAIL if creation failed.

o CreateWeldOnGeometry

public virtual CreateWeldOnGeometry(		`ipGeometrySelected`,
		`ipPlane`,
		`opiCreatedWeld`)

Creates a Weld annotation on a geometrical selection. In part document using this method result in a status To Update for the part, this method does not manage part update.

Parameters:

ipGeometrySelected: This argument define the geometry or feature to which the created annotation will apply to. This CATSO must contain at least a valid PathElement on a geometrical element or feature supported by 3D annotations. A valid PathElement means a PathElement identical to what is obtained by interactive selection. If there are several PathElement the weld will apply on all the geometry selected.
ipPlane: Optionnal, can be used to specify a favorite plane for annotation 3D visualization. If NULL, annotation plane is automaticaly defined. If favorite plane is not convenient for annotation an other plane will be used and specified favorite plane will be ignored.
opiCreatedWeld: The created Weld 3D annotation..

Returns:

S_OK if succeded, E_FAIL if creation failed.

This object is included in the file: CATITPSFactoryAdvanced.h