CIP JavaScript documentation for class " pfcDisplay"

Class pfcDisplay

Description

This interface represents the current session display. Because it is extended by pfcSession the methods and attributes can be accessed using that object. This interface contains methods to display graphics on the screen.

Direct Parent Classes:: pfcParent

Direct Known Subclasses:: pfcBaseSession

Property Summary


`pfcFont`	`CurrentFont`
	The current font used for text graphics in Creo Parametric.

`pfcStdColor`	`CurrentGraphicsColor`
	The standard color used to display new graphics.

`pfcGraphicsMode`	`CurrentGraphicsMode`
	The mode used to display graphics (i.e. normal or complement).

`/* readonly */ pfcFont`	`DefaultFont`
	The default font for this session of Creo Parametric.

`number`	`RotationAngle`
	The rotation angle of created text graphics (default is 0).

`number`	`SlantAngle`
	The slant angle of created text graphics (default is 0).

`number`	`TextHeight`
	The text height of created text graphics.

`number`	`WidthFactor`
	The width-to-height ratio for created text graphics.

Method Summary


`void`	`DrawArc2D (pfcPoint3D Center, number Radius, pfcVector3D StartDirection, pfcVector3D EndDirection)`
	Draws an arc on the screen

`void`	`DrawCircle (pfcPoint3D Center, number Radius)`
	Draws a circle on the screen

`void`	`DrawLine (pfcPoint3D Endpoint)`
	Draws a line on the screen from the last pen position specified to the position specified by the Endpoint argument. The last pen position is specified using this same function previously times or by `pfcDisplay.SetPenPosition()`

`void`	`DrawPolygon2D (pfcPoint2Ds Vertices, /* optional */ pfcStdColor FillColor)`
	Draws two-dimensional polygon on the screen.

`void`	`DrawPolyline (pfcPoint3Ds Points)`
	Draws a series of connected line segments on the screen.

`void`	`DrawText2D (pfcPoint3D StartPoint, string TextLine)`
	Draws text on the screen

`/* optional */ pfcFont`	`GetFontById (number Id)`
	Creates a font object given a Creo Parametric font integer id.

`/* optional */ pfcFont`	`GetFontByName (string Name)`
	Returns a font object given a Creo Parametric font name.

`void`	`Invalidate (pfcModel Model)`
	Invalidates the display list of the model singalling that a repaint is needed.

`void`	`ResetTextAttributes ()`
	Resets the Creo Parametric text attributes to use the default settings

`void`	`SetPenPosition (pfcPoint3D NewPosition)`
	This method enables you to move to a point without producing any graphical output. This method is used when drawing lines using `pfcDisplay.DrawLine()`

Property Detail

pfcFont CurrentFont

The current font used for text graphics in Creo Parametric.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - This means either:

The attributes were not set, OR
The function could not find a font name for the specified font identifier.

pfcStdColor CurrentGraphicsColor

The standard color used to display new graphics.

Exceptions thrown (but not limited to):

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

pfcGraphicsMode CurrentGraphicsMode

The mode used to display graphics (i.e. normal or complement).

/* readonly */ pfcFont DefaultFont

The default font for this session of Creo Parametric.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The function could not find a font name for the specified font identifier.

number RotationAngle

The rotation angle of created text graphics (default is 0).

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The attributes were not set.

number SlantAngle

The slant angle of created text graphics (default is 0).

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The attributes were not set.

number TextHeight

The text height of created text graphics.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The attributes were not set.

number WidthFactor

The width-to-height ratio for created text graphics.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The attributes were not set.

Method Detail

void DrawArc2D (pfcPoint3D Center, number Radius, pfcVector3D StartDirection, pfcVector3D EndDirection)

Draws an arc on the screen

All points are in logical screen cordinates

Parameters:

Center: The center point of the arc
Radius: The radius of the arc
StartDirection: Vector representing the start direction of the arc
EndDirection: Vector representing the end direction of the arc

void DrawCircle (pfcPoint3D Center, number Radius)

Draws a circle on the screen

Center point and orientation is in the coordinate system of the current object. For example, if the current object is a part, the point must be in the part's coordinate system. If the current object is an assembly, the point must be in the assembly's coordinate system. If the current object is a two dimensional model, circle will be normal to the screen.

Parameters:

Center: The center of the circle
Radius: The radius of the circle

void DrawLine (pfcPoint3D Endpoint)

Draws a line on the screen from the last pen position specified to the position specified by the Endpoint argument. The last pen position is specified using this same function previously times or by pfcDisplay.SetPenPosition()

These points are in the coordinate system of the current object. For example, if the current object is a part, the points must be in the part's coordinate system. If the current object is an assembly, the points must be in the assembly's coordinate system.

Parameters:

Endpoint

void DrawPolygon2D (pfcPoint2Ds Vertices, /* optional */ pfcStdColor FillColor)

Draws two-dimensional polygon on the screen.

Exceptions thrown (but not limited to):

pfcXToolkitLineTooLong - You specified more than 100 points.

Parameters:

Vertices: A sequence of two dimensional points representing the polygon's vertices.
FillColor: The color of the polygon. If null, the polygon will be filled using the current graphics color.

void DrawPolyline (pfcPoint3Ds Points)

Draws a series of connected line segments on the screen.

These points are in the coordinate system of the current object. For example, if the current object is a part, the points must be in the part's coordinate system. If the current object is an assembly, the points must be in the assembly's coordinate system. The total number of points should be less than 200.

Parameters:

Points

void DrawText2D (pfcPoint3D StartPoint, string TextLine)

Draws text on the screen

If no text attributes are set before this method call the program uses the default text attributes for Creo Parametric. Set the text attributes using the attributes on the pfcDisplay object.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The font specified in a previous call to ProtText*CurrentSet() was not found.

Parameters:

StartPoint: The starting point for text display, in logical screen coordinates
TextLine: The text to display

/* optional */ pfcFont GetFontById (number Id)

Creates a font object given a Creo Parametric font integer id.

The correspondance between font names and integer identifiers stays constant for a given Creo Parametric session, but may be different for different sessions.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The function could not find a font name for the specified font identifier.

Parameters:

Id: The Creo Parametric integer id of the font.

Returns:: The font object to be used to control the font of text graphics.

/* optional */ pfcFont GetFontByName (string Name)

Returns a font object given a Creo Parametric font name.

The correspondance between font names and integer identifiers stays constant for a given Creo Parametric session, but may be different for different sessions.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The function could not find a font identifier for the specified font name.

Parameters:

Name: The font name

Returns:: The font object to be used to control the font of text graphics

void Invalidate (pfcModel Model)

Invalidates the display list of the model singalling that a repaint is needed.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - The specified model is not a part, assembly, or drawing.

pfcXToolkitNotExist - The function cannot find the window associated with the object.

Parameters:

Model: The part, assembly or drawing

void ResetTextAttributes ()

Resets the Creo Parametric text attributes to use the default settings

void SetPenPosition (pfcPoint3D NewPosition)

This method enables you to move to a point without producing any graphical output. This method is used when drawing lines using pfcDisplay.DrawLine()

This point is in the coordinate system of the current object. For example, if the current object is a part, the point must be in the part's coordinate system. If the current object is an assembly, the point must be in the assembly's coordinate system.

Parameters:

NewPosition