public interface UserDefinedObjectDisplayContext extends TransientObject
Modifier and Type | Interface and Description |
---|---|
static class |
UserDefinedObjectDisplayContext.FacetType
The enumerated type facet to be displayed
|
static class |
UserDefinedObjectDisplayContext.PolyMarker
This enumerated type specifies the type of marker to be displayed.
|
static class |
UserDefinedObjectDisplayContext.StandardTextRef
This enumerated type specifies the type of reference point used in the text box
for standard_text methods.
|
static class |
UserDefinedObjectDisplayContext.TextRef
This enumerated type specifies the type of reference point used in the text box.
|
static class |
UserDefinedObjectDisplayContext.TextSize
Provides a way to specify the size of the desired text, as small,
medium or large (normal is a synonym for medium).
|
static class |
UserDefinedObjectDisplayContext.ViewMode
The enumerated view mode
|
static class |
UserDefinedObjectDisplayContext.ViewModeData
This class holds the data returned from
getViewMode() |
Modifier and Type | Method and Description |
---|---|
void |
displayAbsoluteRotationScreenSizeStandardText(int fontIndex,
String fontStyle,
Point3d textCoordinates,
UserDefinedObjectDisplayContext.StandardTextRef referencePointType,
String string,
UserDefinedObjectDisplayContext.TextSize textSize)
Displays a single line "Standard Text" string using "Absolute Rotation and Screen
Size Geometry" for a
UserDefinedObject . |
void |
displayAbsoluteStandardText(int fontIndex,
String fontStyle,
Point3d textCoordinates,
UserDefinedObjectDisplayContext.StandardTextRef referencePointType,
String string,
double glyphWidth,
double glyphHeight)
Displays a single line "Standard Text" string using "Absolute Geometry" for a
UserDefinedObject . |
void |
displayArc(Point3d center,
Matrix3x3 original,
double radius,
double startAngle,
double endAngle)
Displays an arc for a
UserDefinedObject . |
void |
displayCircle(Point3d center,
Matrix3x3 original,
double radius,
boolean filled)
Displays a circle for a
UserDefinedObject . |
void |
displayFacets(int numVertices,
int numFacets,
Point3d[] vertices,
Vector3d[] normals,
UserDefinedObjectDisplayContext.FacetType typeOfFacet)
Displays a series of facets for a
UserDefinedObject . |
void |
displayMultiLineAbsoluteRotationScreenSizeStandardText(int fontIndex,
String fontStyle,
Point3d textCoordinates,
UserDefinedObjectDisplayContext.StandardTextRef referencePointType,
String[] strings,
UserDefinedObjectDisplayContext.TextSize textSize)
Displays a multi-line "Standard Text" string using "Absolute Rotation and Screen
Size Geometry" for a
UserDefinedObject . |
void |
displayMultiLineAbsoluteStandardText(int fontIndex,
String fontStyle,
Point3d textCoordinates,
UserDefinedObjectDisplayContext.StandardTextRef referencePointType,
String[] strings,
double glyphWidth,
double glyphHeight)
Displays a multi-line "Standard Text" string using "Absolute Geometry" for a
UserDefinedObject . |
void |
displayMultiLineScreenStandardText(int fontIndex,
String fontStyle,
Point3d textCoordinates,
UserDefinedObjectDisplayContext.StandardTextRef referencePointType,
String[] strings,
UserDefinedObjectDisplayContext.TextSize textSize)
Displays a multi-line "Standard Text" string using "Screen Geometry" for a
UserDefinedObject . |
void |
displayPoints(Point3d[] points,
UserDefinedObjectDisplayContext.PolyMarker markerType)
Displays a series of points for a
UserDefinedObject . |
void |
displayPolygon(Point3d[] points,
boolean filled)
Displays a polygon (a closed set of line segements) for a
UserDefinedObject . |
void |
displayPolyline(Point3d[] points)
Displays a polyline (a connected set of line segements) for a
UserDefinedObject . |
void |
displayScreenStandardText(int fontIndex,
String fontStyle,
Point3d textCoordinates,
UserDefinedObjectDisplayContext.StandardTextRef referencePointType,
String string,
UserDefinedObjectDisplayContext.TextSize textSize)
Displays a single line "Standard Text" string using "Screen Geometry" for a
UserDefinedObject . |
void |
displayText(String text,
Point3d textCoordinates,
UserDefinedObjectDisplayContext.TextRef referencePoint)
Displays a text string using an NX text font for a
UserDefinedObject . |
void |
displayUnicodeMarker(String unicodeChar,
int fontIndex,
String fontStyle,
Point3d markerCoordinates,
double markerSize)
Displays a single character in the given font and style centered at the given position.
|
UserDefinedObjectDisplayContext.ViewModeData |
getViewMode()
Displays a single character in the given font and style centered at the given position.
|
_value, dispose, printTestData, printTestData
void displayArc(Point3d center, Matrix3x3 original, double radius, double startAngle, double endAngle) throws NXException, RemoteException
UserDefinedObject
.
The arc will be created in a plane whose normal is the Z axis
of the orientation matrix
(matrix[0-2] is the X axis of the orientation matrix,
matrix[3-5] is the Y axis of the orientation matrix, and
matrix[6-8] is the Y axis of the orientation matrix.)
The start and end angles are measured relative to
the X and Y axis of this orientation matrix.
center
- Center of the arc (absolute coordinates transformed by the orientation matrix)original
- Orientation matrix for the arc.radius
- Radius of the arc. Must be greater than zero.startAngle
- Start angle in radiansendAngle
- End angle in radiansNXException
RemoteException
void displayCircle(Point3d center, Matrix3x3 original, double radius, boolean filled) throws NXException, RemoteException
UserDefinedObject
.
The circle will be created in a plane which is normal to
the Z axis of the orientation matrix.
(matrix[0-2] is the X axis of the orientation matrix,
matrix[3-5] is the Y axis of the orientation matrix, and
matrix[6-8] is the Y axis of the orientation matrix.)
center
- Center of the arc (absolute coordinates transformed by the orientation matrix)original
- Orientation matrix for the arc.radius
- Radius of the arc. Must be greater than zero.filled
- True if the interior of the circle is solid filled,
otherwise the interior is not filledNXException
RemoteException
void displayPolyline(Point3d[] points) throws NXException, RemoteException
UserDefinedObject
.
The line segments are defined by an array of points.
points
- Array of point coordinates which define the polyline.
points[0-2] defines the first point, points[3-5] defines the second point, etc.NXException
RemoteException
void displayPoints(Point3d[] points, UserDefinedObjectDisplayContext.PolyMarker markerType) throws NXException, RemoteException
UserDefinedObject
.
points
- Array of point coordinates.
points[0-2] defines the first point, points[3-5] defines the second point, etc.markerType
- The type of marker displayed for each pointNXException
RemoteException
void displayPolygon(Point3d[] points, boolean filled) throws NXException, RemoteException
UserDefinedObject
.
The line segments are defined by an array of points.
points
- Array of point coordinates which define the polyline.
points[0-2] defines the first end point, points[3-5] defines the second end point, etc.filled
- True if the interior of the polygon is solid filled,
otherwise the interior is not filledNXException
RemoteException
void displayFacets(int numVertices, int numFacets, Point3d[] vertices, Vector3d[] normals, UserDefinedObjectDisplayContext.FacetType typeOfFacet) throws NXException, RemoteException
UserDefinedObject
.
numVertices
- Number of points to define a facet.numFacets
- Number of facets to display.vertices
- Array of point coordinates which define the vertices of the facets.
For example assume num_facets = 2 and num_vertices = 3, then vertices[0-2] defines the point of the first vertex of the first facet,
vertices[3-5] defines the second vertex point of the first facet, and vertices[6-8] defines the last vertex point of the first facet.
Next vertices[9-11] define the first vertex point of the second facet, vertices[12-14] is the second vertex of the second facet, and last
vertices[15-17] defines the last vertex of the second facet.normals
- Array of vectors which define the normal to the facet at a vertex point.
Normal vectors must be unit vectors, and they should point out away from the faceted object.
For example assume num_facets = 2 and num_vertices = 3, then normals[0-8] define the normal vectors at each verte point in the first facet,
and normals[9-17] define the normals for the vertex points of the second facet.
More specifically normals[0-2] should define a unit normal vector out away from the facet at the point defined by vertices[0-2].
Likewise normals[3-5] should define a unit normal vector out away from the facet at the point defined by vertices[3-5].typeOfFacet
- The format of the facet in the facet arrayNXException
RemoteException
void displayText(String text, Point3d textCoordinates, UserDefinedObjectDisplayContext.TextRef referencePoint) throws NXException, RemoteException
UserDefinedObject
.
text
- Text string to display textCoordinates
- Position of text box reference point in absreferencePoint
- Reference point of text boxNXException
RemoteException
void displayAbsoluteStandardText(int fontIndex, String fontStyle, Point3d textCoordinates, UserDefinedObjectDisplayContext.StandardTextRef referencePointType, String string, double glyphWidth, double glyphHeight) throws NXException, RemoteException
UserDefinedObject
. A "Standard Text" string uses one
of the fonts available from the operating system. "Absolute Geometry"
means that the text scales and rotates with the view, so it appears larger
when you zoom in and smaller when you zoom out. This is the type of text
normally used by NX Drafting. Note that the text will be displayed on
the Absolute XY plane.
fontIndex
- Index of the text font to be used.
This must be an index of a standard font.
It may be 0 to use the default font.fontStyle
- The name of a style supported by the given font.
Specify NULL to use the default style for the font,
which usually is Regular (no bold, no italic).
If a non-NULL style does not exist for the font,
the font's default style will be used.textCoordinates
- Position of text box reference point
in Absolute CoordinatesreferencePointType
- Reference point type of text boxstring
- Text string to displayglyphWidth
- Width of text in units of the Displayed PartglyphHeight
- Height of text in units of the Displayed PartNXException
RemoteException
void displayMultiLineAbsoluteStandardText(int fontIndex, String fontStyle, Point3d textCoordinates, UserDefinedObjectDisplayContext.StandardTextRef referencePointType, String[] strings, double glyphWidth, double glyphHeight) throws NXException, RemoteException
UserDefinedObject
. A "Standard Text" string uses one
of the fonts available from the operating system. "Absolute Geometry"
means that the text scales and rotates with the view, so it appears larger
when you zoom in and smaller when you zoom out. This is the type of text
normally used by NX Drafting. Note that the text will be displayed on
the Absolute XY plane.
fontIndex
- Index of the text font to be used.
This must be an index of a standard font.
It may be 0 to use the default font.fontStyle
- The name of a style supported by the given font.
Specify NULL to use the default style for the font,
which usually is Regular (no bold, no italic).
If a non-NULL style does not exist for the font,
the font's default style will be used.textCoordinates
- Position of text box reference point
in Absolute CoordinatesreferencePointType
- Reference point type of text boxstrings
- Array of text strings to displayglyphWidth
- Width of text in units of the Displayed PartglyphHeight
- Height of text in units of the Displayed PartNXException
RemoteException
void displayScreenStandardText(int fontIndex, String fontStyle, Point3d textCoordinates, UserDefinedObjectDisplayContext.StandardTextRef referencePointType, String string, UserDefinedObjectDisplayContext.TextSize textSize) throws NXException, RemoteException
UserDefinedObject
. A "Standard Text" string uses one
of the fonts available from the operating system. "Screen Geometry" means
that the text remains parallel to the screen and appears the same physical
size on the screen regardless of the view scale. This method is not
supported for 2D output such as CGM. Note that the text will be displayed on
the Absolute XY plane.
fontIndex
- Index of the text font to be used.
This must be an index of a standard font.
It may be 0 to use the default font.fontStyle
- The name of a style supported by the given font.
Specify NULL to use the default style for the font,
which usually is Regular (no bold, no italic).
If a non-NULL style does not exist for the font,
the font's default style will be used.textCoordinates
- Position of text box reference point
in Absolute CoordinatesreferencePointType
- Reference point type of text boxstring
- Text string to displaytextSize
- see enum valuesNXException
RemoteException
void displayMultiLineScreenStandardText(int fontIndex, String fontStyle, Point3d textCoordinates, UserDefinedObjectDisplayContext.StandardTextRef referencePointType, String[] strings, UserDefinedObjectDisplayContext.TextSize textSize) throws NXException, RemoteException
UserDefinedObject
. A "Standard Text" string uses one
of the fonts available from the operating system. "Screen Geometry" means
that the text remains parallel to the screen and appears the same physical
size on the screen regardless of the view scale. This method is not
supported for 2D output such as CGM. Note that the text will be displayed on
the Absolute XY plane.
fontIndex
- Index of the text font to be used.
This must be an index of a standard font.
It may be 0 to use the default font.fontStyle
- The name of a style supported by the given font.
Specify NULL to use the default style for the font,
which usually is Regular (no bold, no italic).
If a non-NULL style does not exist for the font,
the font's default style will be used.textCoordinates
- Position of text box reference point
in Absolute CoordinatesreferencePointType
- Reference point type of text boxstrings
- Array of text strings to displaytextSize
- see enum valuesNXException
RemoteException
void displayAbsoluteRotationScreenSizeStandardText(int fontIndex, String fontStyle, Point3d textCoordinates, UserDefinedObjectDisplayContext.StandardTextRef referencePointType, String string, UserDefinedObjectDisplayContext.TextSize textSize) throws NXException, RemoteException
UserDefinedObject
. A "Standard Text"
string uses one of the fonts available from the operating system.
"Absolute Rotation and Screen Size Geometry" means the text appears the
same physical sized on the screen regardless of the view scale (like
"Screen Geometry"), the text remains front-facing and approximately
upright (similar to "Screen Geometry"), but the orientation of the text
changes as the user rotates the view (like "Absolute Geometry").
The text will be displayed on the XY plane of the absolute coordinate system.
This method is not supported for 2D output such as CGM.
fontIndex
- Index of the text font to be used.
This must be an index of a standard font.
It may be 0 to use the default font.fontStyle
- The name of a style supported by the given font.
Specify NULL to use the default style for the font,
which usually is Regular (no bold, no italic).
If a non-NULL style does not exist for the font,
the font's default style will be used.textCoordinates
- Position of text box reference point
in Absolute CoordinatesreferencePointType
- Reference point type of text boxstring
- Text string to displaytextSize
- see enum valuesNXException
RemoteException
void displayMultiLineAbsoluteRotationScreenSizeStandardText(int fontIndex, String fontStyle, Point3d textCoordinates, UserDefinedObjectDisplayContext.StandardTextRef referencePointType, String[] strings, UserDefinedObjectDisplayContext.TextSize textSize) throws NXException, RemoteException
UserDefinedObject
. A "Standard Text"
string uses one of the fonts available from the operating system.
"Absolute Rotation and Screen Size Geometry" means the text appears the
same physical sized on the screen regardless of the view scale (like
"Screen Geometry"), the text remains front-facing and approximately
upright (similar to "Screen Geometry"), but the orientation of the text
changes as the user rotates the view (like "Absolute Geometry").
The text will be displayed on the XY plane of the absolute coordinate system.
This method is not supported for 2D output such as CGM.
fontIndex
- Index of the text font to be used.
This must be an index of a standard font.
It may be 0 to use the default font.fontStyle
- The name of a style supported by the given font.
Specify NULL to use the default style for the font,
which usually is Regular (no bold, no italic).
If a non-NULL style does not exist for the font,
the font's default style will be used.textCoordinates
- Position of text box reference point
in Absolute CoordinatesreferencePointType
- Reference point type of text boxstrings
- Array of text strings to displaytextSize
- see enum valuesNXException
RemoteException
void displayUnicodeMarker(String unicodeChar, int fontIndex, String fontStyle, Point3d markerCoordinates, double markerSize) throws NXException, RemoteException
unicodeChar
- A single Unicode character to display
at the given coordinate position.fontIndex
- Index of the text font to be used.
This must be an index of a standard font.
It may be 0 to use the default font.fontStyle
- The name of a style supported by the given font.
Specify NULL to use the default style for the font,
which usually is Regular (no bold, no italic).
If a non-NULL style does not exist for the font,
the font's default style will be used.markerCoordinates
- Position for the center of the marker
in Absolute CoordinatesmarkerSize
- In inches on the screenNXException
RemoteException
UserDefinedObjectDisplayContext.ViewModeData getViewMode() throws NXException, RemoteException
NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.