CIP C++ documentation for class "wfcExternalObjectDisplayData"

Class wfcExternalObjectDisplayData

# include <wfcExternalObject.h> class wfcExternalObjectDisplayData : public virtual wfcExternalObjectData { xdeclare(wfcExternalObjectDisplayData) ... }; This is a COMPACT class.

Description

Display properties of external object

Manual References:: External Objects: Display Data for External Objects

Method Summary


`static wfcExternalObjectDisplayData_ptr`	`Create (pfcCurveDescriptors_ptr Ents, optional pfcStdColors_ptr EntityColors)`
	Creates a display data information for external object

`optional pfcStdColor`	`GetDisplayColor ()`
`void`	`SetDisplayColor (optional pfcStdColor value)`
	Display color for external object

`pfcCurveDescriptors_ptr`	`GetEntities ()`
`void`	`SetEntities (pfcCurveDescriptors_ptr value)`
	List of entities to display in external object. The entities are specified in the local coordinates of the external object. To transform them to model coordinates, Use method SetTransormationMatrix(). NOTE: The only entities for which this is supported are wfcENTITY_LINE and wfcENTITY_ARC. (Polygons may be drawn as multiple lines, and circles as arcs of extent 2 * pi.)

`optional pfcStdColors_ptr`	`GetEntityColors ()`
`void`	`SetEntityColors (optional pfcStdColors_ptr value)`
	A sequnce of colors for entities

`optional pfcStdLineStyle`	`GetLineStyle ()`
`void`	`SetLineStyle (optional pfcStdLineStyle value)`
	Line style for external object

`optional wfcExternalObjectDisplayDataProperties_ptr`	`GetProperties ()`
`void`	`SetProperties (optional wfcExternalObjectDisplayDataProperties_ptr value)`
	Some display properties for external object

`optional xreal`	`GetScale ()`
`void`	`SetScale (optional xreal value)`
	Scale for external object

`optional pfcMatrix3D_ptr`	`GetTransormationMatrix ()`
`void`	`SetTransormationMatrix (optional pfcMatrix3D_ptr value)`
	Use this matrix to transform from local coordinates to model coordinates

Methods Inherited from Class wfcExternalObjectData:: GetType

Method Detail

`optional pfcStdColor`	`GetDisplayColor`	`()`
`void`	`SetDisplayColor`	`(optional pfcStdColor value)`

Display color for external object

Manual References:: External Objects: Display Data for External Objects, External Objects: Display Data for External Objects, External Objects: Display Data for External Objects

`pfcCurveDescriptors_ptr`	`GetEntities`	`()`
`void`	`SetEntities`	`(pfcCurveDescriptors_ptr value)`

List of entities to display in external object. The entities are specified in the local coordinates of the external object. To transform them to model coordinates, Use method SetTransormationMatrix(). NOTE: The only entities for which this is supported are wfcENTITY_LINE and wfcENTITY_ARC. (Polygons may be drawn as multiple lines, and circles as arcs of extent 2 * pi.)

Manual References:: External Objects: Display Data for External Objects, External Objects: Display Data for External Objects, External Objects: Display Data for External Objects, External Objects: Display Data for External Objects

`optional pfcStdColors_ptr`	`GetEntityColors`	`()`
`void`	`SetEntityColors`	`(optional pfcStdColors_ptr value)`

A sequnce of colors for entities

Manual References:: External Objects: Display Data for External Objects, External Objects: Display Data for External Objects, External Objects: Display Data for External Objects

`optional pfcStdLineStyle`	`GetLineStyle`	`()`
`void`	`SetLineStyle`	`(optional pfcStdLineStyle value)`

Line style for external object

Manual References:: External Objects: Display Data for External Objects, External Objects: Display Data for External Objects, External Objects: Display Data for External Objects

`optional wfcExternalObjectDisplayDataProperties_ptr`	`GetProperties`	`()`
`void`	`SetProperties`	`(optional wfcExternalObjectDisplayDataProperties_ptr value)`

Some display properties for external object

Manual References:: External Objects: Display Data for External Objects, External Objects: Display Data for External Objects, External Objects: Display Data for External Objects

`optional xreal`	`GetScale`	`()`
`void`	`SetScale`	`(optional xreal value)`

Scale for external object

Manual References:: External Objects: Display Data for External Objects, External Objects: Display Data for External Objects, External Objects: Display Data for External Objects

`optional pfcMatrix3D_ptr`	`GetTransormationMatrix`	`()`
`void`	`SetTransormationMatrix`	`(optional pfcMatrix3D_ptr value)`

Use this matrix to transform from local coordinates to model coordinates

Manual References:: External Objects: Display Data for External Objects, External Objects: Display Data for External Objects, External Objects: Display Data for External Objects

static wfcExternalObjectDisplayData_ptr Create (pfcCurveDescriptors_ptr Ents, optional pfcStdColors_ptr EntityColors)

Creates a display data information for external object

Manual References:: External Objects: Display Data for External Objects

Parameters:

Ents
EntityColors

Returns:: A display data for external object