CIP C++ documentation for class "wfcWDisplay"

Class wfcWDisplay

# include <wfcDisplay.h> class wfcWDisplay : public virtual pfcDisplay { xaideclare(wfcWDisplay) ... };

Description

Display and Grapchis related methods

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Direct Known Subclasses:: wfcWBaseSession

Method Summary


`void`	`DrawPolylines (wfcPolylines_ptr SetofPolyline)`
	Draws a set of polylines on the screen

`pfcStdColor`	`GetColorByObjectType (wfcDisplayedType DispType)`
	Retrieves the standard color used for the specified object type

`wfcColorRGBAlternateScheme`	`GetColorRGBAlternateScheme ()`
	Sets color scheme of Creo Parametric session

`wfcColorRGBVersion`	`GetColorRGBVersion ()`
	Gets version of ColorRGB

`optional pfcColorRGB_ptr`	`ModifyGraphicsColor (optional pfcColorRGB_ptr Color)`
	Changes the color used to draw any subsequent graphics

`optional pfcColorRGB_ptr`	`ModifyTextColor (optional pfcColorRGB_ptr Color)`
	Changes the color used to draw any subsequent graphics window text color

`void`	`SetColorRGBAlternateScheme (wfcColorRGBAlternateScheme Scheme)`
	Sets color scheme of Creo Parametric session

`void`	`SetColorRGBVersion (wfcColorRGBVersion Version)`
	Sets version of ColorRGB

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcDisplay:: CreateDisplayList2D, Invalidate, DrawArc2D, DrawPolygon2D, DrawText2D, CreateDisplayList3D, DrawCircle, DrawLine, SetPenPosition, DrawPolyline, GetDefaultFont, GetCurrentFont, SetCurrentFont, GetFontById, GetFontByName, GetTextHeight, SetTextHeight, GetRotationAngle, SetRotationAngle, GetSlantAngle, SetSlantAngle, GetWidthFactor, SetWidthFactor, ResetTextAttributes, GetCurrentGraphicsMode, SetCurrentGraphicsMode, GetCurrentGraphicsColor, SetCurrentGraphicsColor

Method Detail

pfcStdColor GetColorByObjectType (wfcDisplayedType DispType)

Retrieves the standard color used for the specified object type

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No default color entry exists for this entity type.

Manual References:: Graphics: Setting Colors to Match Existing Entities

Parameters:

DispType: Type of object

Returns:: The color typically used by Creo to render the object

void SetColorRGBAlternateScheme (wfcColorRGBAlternateScheme Scheme)

Sets color scheme of Creo Parametric session

Manual References:: Graphics: Color Schemes

Parameters:

Scheme: A Scheme

Returns:

wfcColorRGBAlternateScheme GetColorRGBAlternateScheme ()

Sets color scheme of Creo Parametric session

Manual References:: Graphics: Color Schemes, Graphics: Color Schemes

Returns:: A Scheme

void SetColorRGBVersion (wfcColorRGBVersion Version)

Sets version of ColorRGB

Manual References:: Graphics: Version of Color Map

Parameters:

Version

Returns:

wfcColorRGBVersion GetColorRGBVersion ()

Gets version of ColorRGB

Manual References:: Graphics: Version of Color Map, Graphics: Version of Color Map

Returns:

optional pfcColorRGB_ptr ModifyGraphicsColor (optional pfcColorRGB_ptr Color)

Changes the color used to draw any subsequent graphics

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - The current color is the same as the new color.

Parameters:

Color: The new color to use when drawing a graphics entity. If this is null method returns existing color

Returns:: Modfified color

optional pfcColorRGB_ptr ModifyTextColor (optional pfcColorRGB_ptr Color)

Changes the color used to draw any subsequent graphics window text color

Exceptions thrown (but not limited to):

pfcXToolkitNoChange - The current color is the same as the new color.

Parameters:

Color: The new color to use to display text. If this is null method returns existing color

Returns:: Modified color

void DrawPolylines (wfcPolylines_ptr SetofPolyline)

Draws a set of polylines on the screen

Manual References:: Graphics: Displaying Graphics, Graphics: Displaying Graphics

Parameters:

SetofPolyline: A sequence of polyline

Returns: