Graphics
This section covers Creo Object TOOLKIT Java Graphics including displaying lists, displaying text and using the mouse.
Overview
The methods described in this section allow you to draw temporary graphics in a display window. Methods that are identified as 2D are used to draw entities (arcs, polygons, and text) in screen coordinates. Other entities may be drawn using the current model’s coordinate system or the screen coordinate system’s lines, circles, and polylines. Methods are also included for manipulating text properties and accessing mouse inputs.
Getting Mouse Input
The following methods are used to read the mouse position in screen coordinates with the mouse button depressed. Each method outputs the position and an enumerated type description of which mouse button was pressed when the mouse was at that position. These values are contained in the interface pfcSession.MouseStatus. The enumerated values are defined in pfcSession.MouseButton.
Methods Introduced:
  • pfcSession.Session.UIGetNextMousePick
    		•
  • pfcSession.Session.UIGetCurrentMouseStatus
    		•
    The method pfcSession.Session.UIGetNextMousePick returns the mouse position when you press a mouse button. The input argument is the mouse button that you expect the user to select.
    The method pfcSession.Session.UIGetCurrentMouseStatus returns a value whenever the mouse is moved or a button is pressed. With this method a button does not have to be pressed for a value to be returned. You can use an input argument to flag whether or not the returned positions are snapped to the window grid.
    Drawing a Mouse Box
    This method allows you to draw a mouse box.
    Method Introduced:
  • pfcSession.Session.UIPickMouseBox
    		•
    The method pfcSession.Session.UIPickMouseBox draws a dynamic rectangle from a specified point in screen coordinates to the current mouse position until the user presses the left mouse button. The return value for this method is of the type pfcBase.Outline3D.
    You can supply the first corner location programmatically or you can allow the user to select both corners of the box.
    Cosmetic Properties
    You can enhance your model using Creo Object TOOLKIT Java methods that change the surface properties, or set different light sources. The following section describes these methods in detail.
    Surface Properties
    Methods Introduced:
  • wfcSelect.WSelection.GetVisibleAppearance
    		•
  • wfcSelect.WSelection.SetVisibleAppearance
    		•
  • wfcDisplay.wfcDisplay.Appearance_Create
  • wfcDisplay.Appearance.GetAmbient
    		•
  • wfcDisplay.Appearance.SetAmbient
    		•
  • wfcDisplay.Appearance.GetDescription
    		•
  • wfcDisplay.Appearance.SetDescription
    		•
  • wfcDisplay.Appearance.GetDiffuse
    		•
  • wfcDisplay.Appearance.SetDiffuse
    		•
  • wfcDisplay.Appearance.GetHighlight
    		•
  • wfcDisplay.Appearance.SetHighlight
    		•
  • wfcDisplay.Appearance.GetHighlightColor
    		•
  • wfcDisplay.Appearance.SetHighlightColor
    		•
  • wfcDisplay.Appearance.GetKeywords
    		•
  • wfcDisplay.Appearance.SetKeywords
    		•
  • wfcDisplay.Appearance.GetLabel
    		•
  • wfcDisplay.Appearance.SetLabel
    		•
  • wfcDisplay.Appearance.GetName
    		•
  • wfcDisplay.Appearance.SetName
    		•
  • wfcDisplay.Appearance.GetRGBColor
    		•
  • wfcDisplay.Appearance.SetRGBColor
    		•
  • wfcDisplay.Appearance.GetReflection
    		•
  • wfcDisplay.Appearance.SetReflection
    		•
  • wfcDisplay.Appearance.GetShininess
    		•
  • wfcDisplay.Appearance.SetShininess
    		•
  • wfcDisplay.Appearance.GetTransparency
    		•
  • wfcDisplay.Appearance.SetTransparency
    		•
  • wfcSelect.WSelection.SetVisibleTextures
  • wfcSelect.WSelection.GetVisibleTextures
  • wfcDisplay.wfcDisplay.Texture_Create
    		•
  • wfcDisplay.Texture.GetType
    		•
  • wfcDisplay.Texture.SetType
    		•
  • wfcDisplay.Texture.GetFilePath
    		•
  • wfcDisplay.Texture.SetFilePath
    		•
  • wfcDisplay.Texture.GetPlacement
    		•
  • wfcDisplay.Texture.SetPlacement
    		•
  • wfcDisplay.wfcDisplay.TexturePlacement_Create
  • wfcDisplay.TexturePlacement.GetTextureProjectionType
    		•
  • wfcDisplay.TexturePlacement.SetTextureProjectionType
    		•
  • wfcDisplay.TexturePlacement.GetHorizontalOffset
    		•
  • wfcDisplay.TexturePlacement.SetHorizontalOffset
    		•
  • wfcDisplay.TexturePlacement.GetVerticalOffset
    		•
  • wfcDisplay.TexturePlacement.SetVerticalOffset
    		•
  • wfcDisplay.TexturePlacement.GetRotate
    		•
  • wfcDisplay.TexturePlacement.SetRotate
    		•
  • wfcDisplay.TexturePlacement.GetHorizontalScale
    		•
  • wfcDisplay.TexturePlacement.SetHorizontalScale
    		•
  • wfcDisplay.TexturePlacement.GetVerticalScale
    		•
  • wfcDisplay.TexturePlacement.SetVerticalScale
    		•
  • wfcDisplay.TexturePlacement.GetBumpHeight
    		•
  • wfcDisplay.TexturePlacement.SetBumpHeight
    		•
  • wfcDisplay.TexturePlacement.GetDecalIntensity
    		•
  • wfcDisplay.TexturePlacement.SetDecalIntensity
    		•
  • wfcDisplay.TexturePlacement.GetHorizontalFlip
    		•
  • wfcDisplay.TexturePlacement.SetHorizontalFlip
    		•
  • wfcDisplay.TexturePlacement.GetVerticalFlip
    		•
  • wfcDisplay.TexturePlacement.SetVerticalFlip
    		•
  • wfcSession.WSession.IsTextureFileEmbedded
    		•
  • wfcSession.WSession.GetTextureFilePath
    		•
    The methods wfcSelect.WSelection.GetVisibleAppearance and wfcSelect.WSelection.SetVisibleAppearance enable you to retrieve and set the appearance properties for the specified model using an object of the class WSelection.AppearanceProperties.
    Note
    To set the default surface appearance properties, pass the value NULL to the Appearance parameter of the wfcModel.WModel.SetVisibleAppearance method.
    The class wfcDisplay.Appearance is an interface to the appearance properties and contains the methods described below.
    Use the method wfcDisplay.wfcDisplay.Appearance_Create to create an instance of the wfcDisplay.Appearance object.
    •  Ambient—Specifies the indirect, scattered light the model receives from its surroundings. The valid range is from 0.0 to 1.0.
    •  Description—Specifies the model description.
    •  Diffuse—Specifies the reflected light that comes from directional, point, or spot lights. The valid range is from 0.0 to 1.0.
    •  Highlight—Specifies the intensity of the light reflected from a highlighted surface area. The valid range is from 0.0 to 1.0.
    •  HighlightColor—Specifies the highlight color, in terms of red, green, and blue. The valid range is from 0.0 to 1.0.
    •  Keywords—Specifies the keywords in the specified model.
    •  Label—Specifies the labels in the model.
    •  Name— Specifies the name of the model.
    •  RGBColor— Specifies the color, in the RGB format. The valid range is from 0.0. to 1.0.
    •  Reflection—Specifies how reflective the surface is. The valid range is from 0, that is dull to 100, that is shiny.
    •  Shininess—Specifies the properties of a highlighted surface area. A plastic model would have a lower shininess value, while a metallic model would have a higher value. The valid range is from from 0.0. to 1.0.
    •  Transparency— Specifies the transparency value, which is between 0 that is completely opaque to 1.0 that is completely transparent.
    Use the methods wfcDisplay.Appearance.GetAmbient and wfcDisplay.Appearance.SetAmbient to get and set the ambience value.
    Use the methods wfcDisplay.Appearance.GetDescription and wfcDisplay.Appearance.SetDescription to get and set the description for the specified model.
    Use the methods wfcDisplay.Appearance.GetDiffuse and wfcDisplay.Appearance.SetDiffuse to get and set the value for the diffused light.
    Use the methods wfcDisplay.Appearance.GetHighlight and wfcDisplay.Appearance.SetHighlight to get and set the intensity of the highlighted light.
    Use the methods wfcDisplay.Appearance.GetHighlightColor and wfcDisplay.Appearance.SetHighlightColor to get and set the highlight color.
    Use the methods wfcDisplay.Appearance.GetKeywords and wfcDisplay.Appearance.SetKeywords to get and set the keywords.
    Use the methods wfcDisplay.Appearance.GetLabel and wfcDisplay.Appearance.SetLabel to get and set labels in the specified model.
    Use the methods wfcDisplay.Appearance.GetName and wfcDisplay.Appearance.SetName to get and set the model name for the specified model.
    Use the methods wfcDisplay.Appearance.GetRGBColor and wfcDisplay.Appearance.SetRGBColor to get and set the RGBColor.
    Use the methods wfcDisplay.Appearance.GetReflection and wfcDisplay.Appearance.SetReflection to get and set the reflectivity of the surface.
    Use the methods wfcDisplay.Appearance.GetShininess and wfcDisplay.Appearance.SetShininess to get and set the properties of a highlighted surface area.
    Use the methods wfcDisplay.Appearance.GetTransparency and wfcDisplay.Appearance.SetTransparency to get and set the transparency value.
    Use the methods wfcSelect.WSelection.GetVisibleTextures and wfcSelect.WSelection.SetVisibleTextures to get and set the properties related to the surface texture respectively using an object of the class WSelection. The class wfcDisplay.Texture is an interface to the texture property and contains the methods described below.
    Use the method wfcDisplay.wfcDisplay.Texture_Create to create an instance of the wfcDisplay.wfcDisplay.Texture object. The parameters of this method are given below:
    •  Type—Specifies the type of the texture.
    •  FilePath—Specifies the full path to the texture.
    •  Placement—Specifies the properties related to the placement of surface texture.
    Use the methods wfcDisplay.Texture.GetType and wfcDisplay.Texture.SetType to get and set the type of the texture using the enumerated type wfcDisplay.TextureType.The valid values of the enumerated type wfcTextureType are as follows:
    •  NULL_TEXTURE—Specifies that no texture map is assigned.
    •  BUMP_TEXTURE—Specifies the single-channel texture maps that represent height fields. This texture results in shaded surface and has a wrinkled or irregular appearance.
    •  COLOR_TEXTURE—Specifies the surface color such as woodgrain, geometric patterns, and pictures applied to the texture.
    •  DECAL_TEXTURE—Specifies the specialized texture maps such as company logos or text that are applied to a surface. A decal is a texture with an alpha or transparency mask.
    Use the methods wfcDisplay.Texture.GetFilePath and wfcDisplay.Texture.SetFilePath to get and set the full path to the texture map.
    Use the methods wfcDisplay.Texture.GetPlacement and wfcDisplay.Texture.SetPlacement to get and set the sequence of placements properties using an object of the class wfcDisplay.TexturePlacement. The parameters of the class wfcDisplay.TexturePlacement are as follows:
    Use the method wfcDisplay.wfcDisplay.TexturePlacement_Create to create an instance of the object wfcDisplay.TexturePlacement. The parameters of this method are as follows:
    •  TextureProjectionType—Specifies the projection type of the texture on the selected surface or surfaces.
    •  LineEnvelope—Specifies the coordinate system that defines the direction for the planar projection, or the center for the other projection types.
    •  HorizontalOffset—Specifies the percentage of horizontal shift of the texture map on the surface.
    •  VerticalOffset—Specifies the percentage of vertical shift of the texture map on the surface.
    •  Rotate—Specifies the angle to rotate the texture map on the surface.
    •  HorizontalScale—Specifies the horizontal scaling of the texture map.
    •  VerticalScale—Specifies the vertical scaling of the texture map.
    •  BumpHeight—Specifies the height of the bump on the surface of the texture map.
    •  DecalIntensity—Specifies the alpha or transparency mask intensity on the surface.
    •  HorizontalFlip—Specifies that the texture map on the surface should be flipped horizontally.
    •  VerticalFlip—Specifies that the texture map on the surface should be flipped vertically.
    Use the methods wfcDisplay.TexturePlacement.GetTextureProjectionType and wfcDisplay.TexturePlacement.SetTextureProjectionType to get and set the texture projection type using the enumerated type wfcDisplay.TextureProjectionType.
    Use the methods wfcDisplay.TexturePlacement.GetTextureType and wfcDisplay.TexturePlacement.SetTextureType to get and set the type of texture using the enumerated type wfcTextureType
    Use the methods wfcDisplay.TexturePlacement.GetHorizontalOffset and wfcDisplay.TexturePlacement.SetHorizontalOffset to get and set the horizontal offset.
    Use the methods wfcDisplay.TexturePlacement.GetVerticalOffset and wfcDisplay.TexturePlacement.SetVerticalOffset to get and set the vertical offset.
    Use the methods wfcDisplay.TexturePlacement.GetRotate and wfcDisplay.TexturePlacement.SetRotate to get and set the rotating angle.
    Use the methods wfcDisplay.TexturePlacement.GetHorizontalScale and wfcDisplay.TexturePlacement.SetHorizontalScale to get and set the horizontal scale.
    Use the methods wfcDisplay.TexturePlacement.GetVerticalScale and wfcDisplay.TexturePlacement.SetVerticalScale to get and set the vertical scale.
    Use the methods wfcDisplay.TexturePlacement.GetBumpHeight and wfcDisplay.TexturePlacement.SetBumpHeight to get and set the height of the bump.
    Use the methods wfcDisplay.TexturePlacement.GetDecalIntensity and wfcDisplay.TexturePlacement.SetDecalIntensity to get and set the decal intensity.
    Use the methods wfcDisplay.TexturePlacement.GetHorizontalFlip and wfcDisplay.TexturePlacement.SetHorizontalFlip to get and set the horizontal flip.
    Use the methods wfcDisplay.TexturePlacement.GetVerticalFlip and wfcDisplay.TexturePlacement.SetVerticalFlip to get and set the vertical flip.
    The method wfcSession.WSession.IsTextureFileEmbedded checks if the specified texture, decal, or bump map file is embedded in the model.
    The method wfcSession.WSession.IsTextureFileEmbedded returns the full path of the specified texture, decal, or bump map file and loads the file from the path. If you specify the input argument CreateTempFile as true, the method creates a temporary copy of the texture file.
    Item Properties
    Methods Introduced:
  • wfcSolid.ItemAppearanceAndTextures.GetAppearance
    		•
  • wfcSolid.ItemAppearanceAndTextures.GetTextures
    		•
  • wfcSolid.ItemAppearanceAndTextures.GetSelection
    		•
    The method wfcSolid.ItemAppearanceAndTextures.GetAppearance retrieves the appearance properties for the specified item using the wfcDisplay.Appearance object.
    The method wfcSolid.ItemAppearanceAndTextures.GetTextures retrieves the texture properties for the specified item using the wfcDisplay.Textures object.
    Use the method wfcSolid.ItemAppearanceAndTextures.GetSelection to retrieve the selection handle of the item using the pfcSelect.Selection object.
    For more information, see Surface Properties
    Setting Light Sources
    The methods in this section allow you to set the light sources to render a model in the specified graphics window.
    Methods Introduced:
  • wfcDisplay.WWindow.GetLightInstructions
    		•
  • wfcDisplay.WWindow.SetLightInstructions
    		•
  • wfcDisplay.wfcDisplay.LightSourceInstruction_Create
    		•
  • wfcDisplay.LightSourceInstruction.GetName
    		•
  • wfcDisplay.LightSourceInstruction.SetName
    		•
  • wfcDisplay.LightSourceInstruction.GetType
    		•
  • wfcDisplay.LightSourceInstruction.SetType
    		•
  • wfcDisplay.LightSourceInstruction.GetColor
    		•
  • wfcDisplay.LightSourceInstruction.SetColor
    		•
  • wfcDisplay.LightSourceInstruction.GetPosition
    		•
  • wfcDisplay.LightSourceInstruction.SetPosition
    		•
  • wfcDisplay.LightSourceInstruction.GetDirection
    		•
  • wfcDisplay.LightSourceInstruction.SetDirection
    		•
  • wfcDisplay.LightSourceInstruction.GetSpreadAngle
    		•
  • wfcDisplay.LightSourceInstruction.SetSpreadAngle
    		•
  • wfcDisplay.LightSourceInstruction.GetCastShadows
    		•
  • wfcDisplay.LightSourceInstruction.SetCastShadows
    		•
  • wfcDisplay.LightSourceInstruction.GetIsActive
    		•
  • wfcDisplay.LightSourceInstruction.SetIsActive
    		•
    The method wfcDisplay.WWindow.GetLightInstructions retrieves the information about the light sources in the specified Creo window. Use the method wfcDisplay.WWindow.SetLightInstructions to set the parameters for a light source in the specified window.
    Use the method wfcDisplay.wfcDisplay.LightSourceInstruction_Create to create an instance of the object LightSourceInstruction that contains all the information related to light sources. The parameters of this method are as follows:
    •  inName—Specifies the name of the light source.
    •  inType—Specifies the type of light using the enumerated data type wfcLightType. The light types are —ambient, direction, point, spot, or HDRI.
    •  inColor—Specifies the color of the light in red, green, and blue values.
    •  inIsActive—Specifies if the light source is active.
    Use the methods wfcDisplay.LightSourceInstruction.GetName and wfcDisplay.LightSourceInstruction.SetName to get and set the name of the light source.
    Use the methods wfcDisplay.LightSourceInstruction.GetType and wfcDisplay.LightSourceInstruction.SetType to get and set the type of light source using the enumerated data type wfcDisplay.LightType. The light types are:
    •  LIGHT_AMBIENT—Ambient light illuminates all the surfaces equally. The position of the light in the room has no effect on the rendering. Ambient light exists by default and cannot be created or set in Creo application.
    •  LIGHT_DIRECTION—Directional light casts parallel light rays illuminating all surfaces at the same angle, regardless of the position of the model.
    •  LIGHT_POINT—Point light is similar to the light from a bulb in a room where the light radiates from the center. The light reflected off a surface varies, depending on the surface position with respect to the light.
    •  LIGHT_SPOT—Spotlight is similar to a light bulb but with its rays confined within a cone called the spot angle.
    •  LIGHT_HDRI—High Dynamic Range Image (HDRI) is used to illuminate the model. The light type cannot be set in Creo application.
    Use the methods wfcDisplay.LightSourceInstruction.GetColor and wfcDisplay.LightSourceInstruction.SetColor to get and set the color of light as red, green, and blue values.
    The method wfcDisplay.LightSourceInstruction.GetIsActive checks if the light source is active. Use the method wfcDisplay.LightSourceInstruction.SetIsActive to set the light source as active.
    Use the methods wfcDisplay.LightSourceInstruction.GetPosition and wfcDisplay.LightSourceInstruction.SetPosition to get and set the position of the light source. Specify the position only for point and spot lights.
    Use the methods wfcDisplay.LightSourceInstruction.GetDirection and wfcDisplay.LightSourceInstruction.SetDirection to get and set the direction of the light source. Specify the direction only for direction and spot lights.
    Use the methods wfcDisplay.LightSourceInstruction.GetSpreadAngle and wfcDisplay.LightSourceInstruction.SetSpreadAngle to get and set the angle to which the light is spread in radians. Specify the spread angle only for spot light.
    Use the method wfcDisplay.LightSourceInstruction.GetCastShadows to identify if the light source casts a shadow. The wfcDisplay.LightSourceInstruction.SetCastShadows sets the light source to cast a shadow. Shadows can be applied only in Creo Render Studio. Refer to Creo Render Studio Help for more information.
    Graphics Colors
    Creo application uses several predefined colors in its color map which correspond to the system colors presented to the user through the user interface. The names of the types generally indicate what they are used for in Creo application.
    Note
    PTC reserves the right to change both the definitions of the predefined colormap and also of the assignment of entities to members of the color map as required by improvements to the user interface. PTC recommends not relying on the predefined RGB color for displaying of Creo Object TOOLKIT Java entities or graphics, and also recommends against relying on the relationship between certain colormap entries and types of entities. The following sections describe how to construct your application so that it does not rely on potentially variant properties in Creo application.
    Setting Colors to Match Existing Entities
    Method Introduced:
  • wfcDisplay.WDisplay.GetColorByObjectType
    		•
    The method wfcDisplay.WDisplay.GetColorByObjectType returns the standard color used to display the specified entity in Creo application.
    The association between objects and colormap entries may change in a new release of Creo. This causes the association between the application entities and the Creo entities to be lost. You can use this method to get the display color of the entity.
    Version of Color Map
    Methods Introduced:
  • wfcDisplay.WDisplay.GetColorRGBVersion
    		•
  • wfcDisplay.WDisplay.SetColorRGBVersion
    		•
    The method wfcDisplay.WDisplay.GetColorRGBVersion returns the version of the Creo color map. Use the method wfcDisplay.WDisplay.SetColorRGBVersion to set the version of the color map using the enumerated data type wfcDisplay.ColorRGBVersion. To specify a color map from releases prior to the Pro/ENGINEER Wildfire release specify the value as:
    •  COLORRGB_STANDARD_VERSION—Specifies the appearance.dmt files for the color map.
    •  COLORRGB_PRE_WILDFIRE_VERSION—Specifies the color.map files for the color map from releases prior to the Pro/ENGINEER Wildfire release.
    Color Schemes
    Methods Introduced:
  • wfcDisplay.WDisplay.GetColorRGBAlternateScheme
    		•
  • wfcDisplay.WDisplay.SetColorRGBAlternateScheme
    		•
    The method wfcDisplay.WDisplay.SetColorRGBAlternateScheme allow you to change the color scheme of Creo application to a predefined alternate color scheme. The alternate color scheme defined in the enumerated data type wfcDisplay.ColorRGBAlternateScheme has the following valid values:
    •  COLORRGB_ALT_DEFAULT—Resets the color scheme to the default color scheme of light to dark blue gradient background.
    •  COLORRGB_ALT_BLACK_ON_WHITE—Displays black entities on a white background.
    •  COLORRGB_ALT_WHITE_ON_BLACK—Displays white entities on a black background.
    •  COLORRGB_ALT_WHITE_ON_GREEN—Displays white entities on a dark green background.
    •  COLORRGB_OPTIONAL1—Represents the color scheme with a dark background.
    •  COLORRGB_OPTIONAL2—Represents the color scheme with a medium background.
    •  COLORRGB_CLASSIC_WF—Resets the color scheme to the light to dark grey background. This was the default color scheme till Pro/ENGINEER Wildfire 4.0.
    Use the method wfcDisplay.WDisplay.GetColorRGBAlternateScheme to get the current alternate color scheme.
    Line Styles for Graphics
    Methods Introduced:
  • wfcSession.WSession.GetLineStyleData
    		•
  • wfcSession.LineStyleData.GetName
    		•
  • wfcSession.LineStyleData.GetDefinition
    		•
  • wfcSession.LineStyleData.GetCapStyle
    		•
  • wfcSession.LineStyleData.GetJoinStyle
    		•
  • wfcSession.LineStyleData.GetDashOffset
    		•
  • wfcSession.LineStyleData.GetDashList
    		•
  • wfcSession.LineStyleData.GetFillStyle
    		•
  • wfcSession.LineStyleData.GetFillRule
    		•
    The method wfcSession.WSession.GetLineStyleData returns information about the specified line style as a LineStyleData object.
    The method wfcSession.LineStyleData.GetName returns the name of the specified line style.
    The method wfcSession.LineStyleData.GetDefinition returns the definition of the line style as a series of dashes (-) and spaces ( ).
    The method wfcSession.LineStyleData.GetCapStyle returns the cap style used for line ends. The method wfcSession.LineStyleData.GetJoinStyle returns the style in which line ends are joined. The cap style and join line settings are used from the pen table file for printing a drawing file as a PDF document.
    The method wfcSession.LineStyleData.GetDashOffset returns the distance between the two dashes in the pattern.
    The method wfcSession.LineStyleData.GetDashList returns a list of dashes defined in the specified line style.
    The method wfcSession.LineStyleData.GetFillStyle returns the name of the line font for the specified line style.
    The method wfcSession.LineStyleData.GetFillRule returns the rule defined to fill a unit of length with the line style pattern.
    Displaying Graphics
    All the methods in this section draw graphics in the Creo current window and use the color and linestyle set by calls to pfcSession.BaseSession.SetStdColorFromRGB and pfcSession.BaseSession.SetLineStyle. The methods draw the graphics in the Creo graphics color. The default graphics color is white.
    The methods in this section are called using the interfacepfcDisplay.Display. This interface is extended by the pfcSession.BaseSession interface. This architecture allows you to call all these methods on any Session object.
    y default graphic elements are not stored in the Creo display list. Thus, they do not get redrawn by Creo when the user uses repaint and orientation commands. However, if you store graphic elements in either 2-D or 3-D display lists, Creo application will redraw them when appropriate. See the section on Display Lists and Graphics for more information.
    Methods Introduced:
  • pfcDisplay.Display.SetPenPosition
    		•
  • pfcDisplay.Display.DrawLine
    		•
  • pfcDisplay.Display.DrawPolyline
    		•
  • wfcDisplay.WDisplay.DrawPolylines
    		•
  • pfcDisplay.Display.DrawCircle
    		•
  • pfcDisplay.Display.DrawArc2D
    		•
  • pfcDisplay.Display.DrawPolygon2D
    		•
    The method pfcDisplay.Display.SetPenPosition sets the point at which you want to start drawing a line. The function pfcDisplay.Display.DrawLine draws a line to the given point from the position given in the last call to either of the two functions. Call pfcDisplay.Display.SetPenPosition for the start of the polyline, and pfcDisplay.Display.DrawLine for each vertex. If you use these methods in two-dimensional modes, use screen coordinates instead of solid coordinates.
    The method pfcDisplay.Display.DrawCircle uses solid coordinates for the center of the circle and the radius value. The circle will be placed to the XY plane of the model.
    The method pfcDisplay.Display.DrawPolyline also draws polylines, using an array to define the polyline.
    Use the method wfcDisplay.WDisplay.DrawPolylines to draw multiple polylines. Pass the sequence of polylines as a wfcPolylines object as the input argument.
    In two-dimensional models the Display Graphics methods draw graphics at the specified screen coordinates.
    The method pfcDisplay.Display.DrawPolygon2D draws a polygon in screen coordinates. The method pfcDisplay.Display.DrawArc2D draws an arc in screen coordinates.
    Controlling Graphics Display
    Methods Introduced:
  • pfcDisplay.Display.GetCurrentGraphicsColor
    		•
  • pfcDisplay.Display.SetCurrentGraphicsColor
    		•
  • pfcDisplay.Display.GetCurrentGraphicsMode
    		•
  • pfcDisplay.Display.SetCurrentGraphicsMode
    		•
    The method pfcDisplay.Display.GetCurrentGraphicsColor returns the standard color used to display graphics in the Creo application. TheCreo default is COLOR_DRAWING (white). The method pfcDisplay.Display.SetCurrentGraphicsColor allows you to change the color used to draw subsequent graphics.
    The method pfcDisplay.Display.GetCurrentGraphicsMode returns the mode used to draw graphics:
    •  DRAW_GRAPHICS_NORMAL—Creo application draws graphics in the required color in each invocation.
    •  DRAW_GRAPHICS_COMPLEMENT—Creo application draws graphics normally, but will erase graphics drawn a second time in the same location. This allows you to create rubber band lines.
    The method pfcDisplay.Display.GetCurrentGraphicsMode allows you to set the current graphics mode.
    Displaying Text in the Graphics Window
    Method Introduced:
  • pfcDisplay.Display.DrawText2D
    		•
    The method pfcDisplay.Display.DrawText2D places text at a position specified in screen coordinates. If you want to add text to a particular position on the solid, you must transform the solid coordinates into screen coordinates by using the view matrix.
    Text items drawn are not known to Creo and therefore are not redrawn when you select View, Repaint. To notify the Creo application of these objects, create them inside the OnDisplay() method of the Display Listener.
    Controlling Text Attributes
    Methods Introduced:
  • pfcDisplay.Display.GetTextHeight
    		•
  • pfcDisplay.Display.SetTextHeight
    		•
  • pfcDisplay.Display.GetWidthFactor
    		•
  • pfcDisplay.Display.SetWidthFactor
    		•
  • pfcDisplay.Display.GetRotationAngle
    		•
  • pfcDisplay.Display.SetRotationAngle
    		•
  • pfcDisplay.Display.GetSlantAngle
    		•
  • pfcDisplay.Display.SetSlantAngle
    		•
    These methods control the attributes of text added by calls to pfcDisplay.Display.DrawText2D.
    You can get and set the following information:
    •  Text height (in screen coordinates)
    •  Width ratio of each character, including the gap, as a proportion of the height
    •  Rotation angle of the whole text, in counterclockwise degrees
    •  Slant angle of the text, in clockwise degrees
    Controlling Text Fonts
    Methods Introduced:
  • pfcDisplay.Display.GetDefaultFont
  • pfcDisplay.Display.GetCurrentFont
    		•
  • pfcDisplay.Display.SetCurrentFont
    		•
  • pfcDisplay.Display.GetFontById
    		•
  • pfcDisplay.Display.GetFontByName
    		•
    The method pfcDisplay.Display.GetDefaultFont returns the default Creo text font. The text fonts are identified in Creo application by names and by integer identifiers. To find a specific font, use the methods pfcDisplay.Display.GetFontById or pfcDisplay.Display.GetFontByName.
    Display Lists and Graphics
    When generating a display of a solid in a window, Creo application maintains two display lists. A display list contains a set of vectors that are used to represent the shape of the solid in the view. A 3D display list contains a set of three-dimensional vectors that represent an approximation to the geometry of the edges of the solid. This list gets rebuilt every time the solid is regenerated.
    A 2D display list contains the two-dimensional projections of the edges of the solid 3D display list onto the current window. It is rebuilt from the 3D display list when the orientation of the solid changes. The methods in this section enable you to add your own vectors to the display lists, so that the graphics will be redisplayed automatically by Creo application until the display lists are rebuilt.
    When you add graphics items to the 2D display list, they will be regenerated after each repaint (when zooming and panning) and will be included in plots created by Creo. When you add graphics to the 3D display list, you get the further benefit that the graphics survive a change to the orientation of the solid and are displayed even when you spin the solid dynamically.
    Methods Introduced:
  • pfcDisplay.DisplayListener.OnDisplay
    		•
  • pfcDisplay.Display.CreateDisplayList2D
    		•
  • pfcDisplay.Display.CreateDisplayList3D
    		•
  • pfcDisplay.DisplayList2D.Display
    		•
  • pfcDisplay.DisplayList3D.Display
    		•
  • pfcDisplay.DisplayList2D.Delete
    		•
  • pfcDisplay.DisplayList3D.Delete
    		•
    A display listener is a class that acts similarly to an action listener. You must implement the method inherited from the pfcDisplay.DisplayListener interface. The implementation should provide calls to methods on the provided pfcDisplay.Display object to produce 2D or 3D graphics.
    In order to create a display list in Creo application, you must call pfcDisplay.Display.CreateDisplayList2D or pfcDisplay.Display.CreateDisplayList3D to tell Creo application to use your listener to create the display list vectors.
    pfcDisplay.DisplayList2D.Display or pfcDisplay.DisplayList3D.Display will display or redisplay the elements in your display list. The application should delete the display list data when it is no longer needed.
    The methods pfcDisplay.DisplayList2D.Delete and the method pfcDisplay.DisplayList3D.Delete will remove both the specified display list from a session.
    Note
    The method pfcWindow.Window.Refresh does not cause either of the display lists to be regenerated, but simply repaints the window using the 2D display list.
    Exceptions
    Possible exceptions that might be thrown by displaying graphics methods are shown in the following table:
    Exception
    Reason
    XToolkitNotExist
    The display list is empty.
    XToolkitNotFound
    The function could not find the display list or the font specified in a previous call to pfcDisplay.Display.SetCurrentFont was not found.
    XToolkitCantOpen
    The use of display lists is disabled.
    XToolkitAbort
    The display was aborted.
    XToolkitNotValid
    The specified display list is invalid.
    XToolkitInvalidItem
    There is an invalid item in the display list.
    XToolkitGeneralError
    The specified display list is already in the process of being displayed.