API Documentation > Interfaces > Interface Display
Interface Display

package com.ptc.pfc.pfcDisplay;

public interface Display
extends com.ptc.pfc.pfcObject.Parent


Description
This interface represents the current session display. Because it is extended by Session the methods and attributes can be accessed using that object. This interface contains methods to display graphics on the screen.
To maintain displayed graphics even after a window repaint create an instance of DisplayList2D or DisplayList3D and place the graphics calls in the display list's DisplayListener.OnDisplay(Display) method.
Direct Known Subclasses:
Method Summary
Creates a two-dimensional display list
Creates a three-dimensional display list entity
void
DrawArc2D (Point3D Center, double Radius, Vector3D StartDirection, Vector3D EndDirection)
Draws an arc on the screen
void
DrawCircle (Point3D Center, double Radius)
Draws a circle on the screen
void
DrawLine (Point3D 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 byDisplay.SetPenPosition(Point3D)
void
DrawPolygon2D (Point2Ds Vertices, /*optional*/ StdColor FillColor)
Draws two-dimensional polygon on the screen.
void
Draws a series of connected line segments on the screen.
void
DrawText2D (Point3D StartPoint, String TextLine)
Draws text on the screen
Get method for attribute "CurrentFont"
The current font used for text graphics in Creo Parametric.
Get method for attribute "CurrentGraphicsColor"
The standard color used to display new graphics.
Get method for attribute "CurrentGraphicsMode"
The mode used to display graphics (i.e. normal or complement).
Get method for attribute "DefaultFont"
The default font for this session of Creo Parametric.
/*optional*/ Font
GetFontById (int Id)
Creates a font object given a Creo Parametric font integer id.
/*optional*/ Font
GetFontByName (String Name)
Returns a font object given a Creo Parametric font name.
double
Get method for attribute "RotationAngle"
The rotation angle of created text graphics (default is 0).
double
Get method for attribute "SlantAngle"
The slant angle of created text graphics (default is 0).
double
Get method for attribute "TextHeight"
The text height of created text graphics.
double
Get method for attribute "WidthFactor"
The width-to-height ratio for created text graphics.
void
Invalidates the display list of the model singalling that a repaint is needed.
void
Resets the Creo Parametric text attributes to use the default settings
void
Set method for attribute "CurrentFont"
The current font used for text graphics in Creo Parametric.
void
Set method for attribute "CurrentGraphicsColor"
The standard color used to display new graphics.
void
Set method for attribute "CurrentGraphicsMode"
The mode used to display graphics (i.e. normal or complement).
void
SetPenPosition (Point3D NewPosition)
This method enables you to move to a point without producing any graphical output. This method is used when drawing lines usingDisplay.DrawLine(Point3D)
void
SetRotationAngle (double value)
Set method for attribute "RotationAngle"
The rotation angle of created text graphics (default is 0).
void
SetSlantAngle (double value)
Set method for attribute "SlantAngle"
The slant angle of created text graphics (default is 0).
void
SetTextHeight (double value)
Set method for attribute "TextHeight"
The text height of created text graphics.
void
SetWidthFactor (double value)
Set method for attribute "WidthFactor"
The width-to-height ratio for created text graphics.
Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent :
Method Detail
CreateDisplayList2D
CreateDisplayList2D
(int Id, ScreenTransform Transform, DisplayListener Action)
Creates a two-dimensional display list
Two dimensional display list operations in Creo Parametric are not currently supported. This method is reserved for future activation.
Manual References:
Parameters:
Id
Transform
The transformation matrix to be applied to the entities of the display list.
Action
The user-defined DisplayListener that calls Display methods to populate the display.
Returns:
The newly created DisplayList2D class instance
Invalidate
void
Invalidate
(Model Model)
Invalidates the display list of the model singalling that a repaint is needed.
Exceptions thrown (but not limited to):
XToolkitInvalidType - The specified model is not a part, assembly, or drawing.
XToolkitNotExist - The function cannot find the window associated with the object.
Parameters:
Model
The part, assembly or drawing
Returns:
DrawArc2D
void
DrawArc2D
(Point3D Center, double Radius, Vector3D StartDirection, Vector3D EndDirection)
Draws an arc on the screen
All points are in logical screen cordinates
Manual References:
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
Returns:
DrawPolygon2D
void
DrawPolygon2D
(Point2Ds Vertices, /*optional*/ StdColor FillColor)
Draws two-dimensional polygon on the screen.
Exceptions thrown (but not limited to):
XToolkitLineTooLong - You specified more than 100 points.
Manual References:
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.
Returns:
DrawText2D
void
DrawText2D
(Point3D 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 Display object.
Exceptions thrown (but not limited to):
XToolkitNotFound - The font specified in a previous call to ProtText*CurrentSet() was not found.
Manual References:
Parameters:
StartPoint
The starting point for text display, in logical screen coordinates
TextLine
The text to display
Returns:
CreateDisplayList3D
CreateDisplayList3D
(int Id, DisplayListener Action)
Creates a three-dimensional display list entity
Manual References:
Parameters:
Id
The identifier of the display list. This number must be unique.
Action
The user-defined DisplayListener that calls Display methods to create the display list.
Returns:
The newly-created DisplayList3D class instance
DrawCircle
void
DrawCircle
(Point3D Center, double 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.
Manual References:
Parameters:
Center
The center of the circle
Radius
The radius of the circle
Returns:
DrawLine
void
DrawLine
(Point3D 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 Display.SetPenPosition(Point3D)
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.
Manual References:
Parameters:
Endpoint
Returns:
SetPenPosition
void
SetPenPosition
(Point3D NewPosition)
This method enables you to move to a point without producing any graphical output. This method is used when drawing lines using Display.DrawLine(Point3D)
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.
Manual References:
Parameters:
NewPosition
Returns:
DrawPolyline
void
DrawPolyline
(Point3Ds 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.
Manual References:
Parameters:
Points
Returns:
GetDefaultFont
GetDefaultFont
()
The default font for this session of Creo Parametric.
Exceptions thrown (but not limited to):
XToolkitNotFound - The function could not find a font name for the specified font identifier.
Manual References:
GetCurrentFont
GetCurrentFont
()
SetCurrentFont
void
SetCurrentFont
(Font value)
The current font used for text graphics in Creo Parametric.
Exceptions thrown (but not limited to):
XToolkitNotFound - This means either:
• The attributes were not set, OR
• The function could not find a font name for the specified font identifier.
Manual References:
GetFontById
/*optional*/ Font
GetFontById
(int 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):
XToolkitNotFound - The function could not find a font name for the specified font identifier.
Manual References:
Parameters:
Id
The Creo Parametric integer id of the font.
Returns:
The font object to be used to control the font of text graphics.
GetFontByName
/*optional*/ Font
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):
XToolkitNotFound - The function could not find a font identifier for the specified font name.
Manual References:
Parameters:
Name
The font name
Returns:
The font object to be used to control the font of text graphics
GetTextHeight
double
GetTextHeight
()
SetTextHeight
void
SetTextHeight
(double value)
The text height of created text graphics.
Exceptions thrown (but not limited to):
XToolkitNotFound - The attributes were not set.
Manual References:
GetRotationAngle
double
GetRotationAngle
()
SetRotationAngle
void
SetRotationAngle
(double value)
The rotation angle of created text graphics (default is 0).
Exceptions thrown (but not limited to):
XToolkitNotFound - The attributes were not set.
Manual References:
GetSlantAngle
double
GetSlantAngle
()
SetSlantAngle
void
SetSlantAngle
(double value)
The slant angle of created text graphics (default is 0).
Exceptions thrown (but not limited to):
XToolkitNotFound - The attributes were not set.
Manual References:
GetWidthFactor
double
GetWidthFactor
()
SetWidthFactor
void
SetWidthFactor
(double value)
The width-to-height ratio for created text graphics.
Exceptions thrown (but not limited to):
XToolkitNotFound - The attributes were not set.
Manual References:
ResetTextAttributes
void
ResetTextAttributes
()
Resets the Creo Parametric text attributes to use the default settings
Returns:
GetCurrentGraphicsMode
GetCurrentGraphicsMode
()
SetCurrentGraphicsMode
void
SetCurrentGraphicsMode
(GraphicsMode value)
The mode used to display graphics (i.e. normal or complement).
Manual References:
GetCurrentGraphicsColor
GetCurrentGraphicsColor
()
SetCurrentGraphicsColor
void
SetCurrentGraphicsColor
(StdColor value)
The standard color used to display new graphics.
Exceptions thrown (but not limited to):
XToolkitNoChange - The current color is the same as the new color.
Manual References:
Was this helpful?