CIP C++ documentation for file "wfcSession.h"

File "wfcSession.h"

Description

Similar to its predecessor J-Link, Object Toolkit top level object is a session, which provides methods to get objects representing Creo Parametric models, model items, parameters and so on.

Since Object Toolkit has more functional features than J-Link, its actual Session object, returned by pfcGetProESession, is of type wfcWSession.

Interface wfcWSession combines methods from pfcSession and methods which are available only in Object Toolkit. Besides, methods for obtaining models now return Object Toolkit classes instead of J-Link.

As pfcGetProESession is shared by both Object Toolkit and J-Link, it declares the type of the returned session as pfcSession. To obtain wfcWSession, this object should be cast to that type:

    wfcWSession_ptr ses = wfcWSession::cast(pfcGetProESession() );

Enumerated Types

`enum`	`wfcIntfDataSourceType`
	Provides the type of IntfDataSource.
`enum`	`wfcWModelRetrieveOption`
	Provides options to retrieve model.
`enum`	`wfcKnownDirectoryType`

`enum`	`wfcCreoType`

`enum`	`wfcKinDragType`

Interface Classes

`class`	`wfcBeforeModelRetrieveActionListener`

	This class delgates the event before activating file open dialog using File -> Open.
`class`	`wfcBeforeModelRetrieveInstructions`
	This is a COMPACT class.
	This class specifies the instructions for action listener `wfcBeforeModelRetrieveActionListener`.
`class`	`wfcBeforeModelRetrieveListener`


`class`	`wfcBeforeModelSaveAllListener`


`class`	`wfcBrowserMessageListener`


`class`	`wfcElementWstringOption`
	This is a COMPACT class.

`class`	`wfcFiletypeOpenOptions`
	This is a COMPACT class.
	This class specifies the options for file open dialog.
`class`	`wfcFiletypeSaveOptions`
	This is a COMPACT class.
	This class specifies the options for file save dialog.
`class`	`wfcLineStyleData`
	This is a COMPACT class.
	Provides the information about the Line Style.
`class`	`wfcParsedFileNameData`
	This is a COMPACT class.

`class`	`wfcRunnableAction`


`class`	`wfcSnapshotTransformation`
	This is a COMPACT class.

`class`	`wfcTimer`


`class`	`wfcTimerAction`


`class`	`wfcTimeValue`
	This is a COMPACT class.

`class`	`wfcWBaseSession`


`class`	`wfcWSession`

	Top interface in Object Toolkit.

Collection Classes

`class`	`wfcSnapshotTransformations`
	This is a COMPACT class.

`class`	`wfcWModelRetrieveOptions`
	This is a COMPACT class.

Functions

`pfcMatrix3D_ptr`	`wfcCreateMatrix3D`	`(xreal idx00, xreal idx01, xreal idx02, xreal idx03, xreal idx10, xreal idx11, xreal idx12, xreal idx13, xreal idx20, xreal idx21, xreal idx22, xreal idx23, xreal idx30, xreal idx31, xreal idx32, xreal idx33)`
	Intialize a 3 dimensional Matrix with specified values
`pfcOutline2D_ptr`	`wfcCreateOutline2D`	`(xreal idx00, xreal idx01, xreal idx10, xreal idx11)`
	Intialize a 2 dimensional Line with specified values
`pfcOutline3D_ptr`	`wfcCreateOutline3D`	`(xreal idx00, xreal idx01, xreal idx02, xreal idx10, xreal idx11, xreal idx12)`
	Intialize a 3 dimensional Line with specified values
`pfcPoint2D_ptr`	`wfcCreatePoint2D`	`(xreal idx0, xreal idx1)`
	Intialize a 2 dimensional Point with specified values
`pfcPoint3D_ptr`	`wfcCreatePoint3D`	`(xreal idx0, xreal idx1, xreal idx2)`
	Intialize a 3 dimensional Point with specified values
`wfcTimer_ptr`	`wfcCreateTimer`	`(wfcTimerAction_ptr Action)`
	Create timer object with specified listener. This method can be called from non-Toolkit thread. For example , Thread created by application to process non-Creo tasks.
`pfcVector2D_ptr`	`wfcCreateVector2D`	`(xreal idx0, xreal idx1)`
	Intialize a 2 dimensional Vector with specified values
`pfcVector3D_ptr`	`wfcCreateVector3D`	`(xreal idx0, xreal idx1, xreal idx2)`
	Intialize a 3 dimensional Vector with specified values
`void`	`wfcInvokeLater`	`(wfcRunnableAction_ptr Action)`
	Create listener object whose callback can be called as soon as Toolkit thread is available. User can call Object Toolkit methods in this callback. This method can be called from non-Toolkit thread. For example , Thread created by application to process non-Creo tasks.