public interface ImageBaseBuilder extends Builder
ImageBaseBuilder
.
Serves as the base class for all ImageBase
builders.
ImageBase
base class provides definition, orientation,
sizing, and display setting controls for image based objects.
Modifier and Type | Interface and Description |
---|---|
static class |
ImageBaseBuilder.BasePointChoices
Specifies image reference base point choice.
|
static class |
ImageBaseBuilder.CornerPointsData
This class holds the data returned from
getCornerPoints() |
static class |
ImageBaseBuilder.ImageColorModes
Describes image color modes.
|
static class |
ImageBaseBuilder.InsertionPoint
Describes insertion point type.
|
static class |
ImageBaseBuilder.ReferenceDirection
Specifies image alignment reference direction type.
|
static class |
ImageBaseBuilder.SizeOptions
Describes size options.
|
static class |
ImageBaseBuilder.TransparencyColorFrom
Transparency Color From
|
Modifier and Type | Method and Description |
---|---|
void |
alignImageToReferenceDirection()
Align Image to Reference Direction
License requirements: None. |
ImageBaseBuilder.BasePointChoices |
basePointChoice()
Returns the image reference base point choice.
|
ImageBaseBuilder.ImageColorModes |
colorMode()
Returns the color mode to display the image.
|
void |
flipHorizontal()
Flips the image horizontally.
|
void |
flipVertical()
Flips the image vertically.
|
double[] |
getBackgroundColor()
Gets the background color (RGB value) of the image.
|
ImageBaseBuilder.CornerPointsData |
getCornerPoints()
Get the image corner points.
|
double[] |
getForegroundColor()
Gets the foreground color (RGB value) of the image.
|
String[] |
getImagesInPart()
Provide a list of names of the
ImageData
objects saved in current part file. |
double[] |
getTransparentPixelColor()
Gets the transparency color (RGB value) of the image.
|
Expression |
height()
Returns the height of the image as an
Expression . |
String |
imageFile()
Returns the image file
License requirements: None. |
Point |
imageReferencePoint1()
Returns the image reference point1.
|
Point |
imageReferencePoint2()
Returns the image reference point2.
|
Point |
imageReferencePoint3()
Returns the image reference point3.
|
ImageBaseBuilder.InsertionPoint |
insertionPointOption()
Returns the image insertion point type
License requirements: None. |
boolean |
lockAspectRatio()
Returns the lock aspect ratio
License requirements: None. |
Point |
modelReferencePoint1()
Returns the model reference point1.
|
Point |
modelReferencePoint2()
Returns the model reference point2.
|
Point |
modelReferencePoint3()
Returns the model reference point3.
|
void |
orientViewToImage()
Orients and fits the work view's view direction along the reverse normal direction of the image
License requirements: None. |
int |
overallTranslucency()
Returns the overall translucency.
|
int |
pixelColorTolerance()
Returns the transparency pixel color tolerance.
|
ImageBaseBuilder.ReferenceDirection |
referenceDirectionOption()
Returns the image alignment reference direction type.
|
void |
resetImageSize()
Resets the image to its original size.
|
Expression |
rotateAngleOfReferenceVector()
Returns the current rotation angle of image from aligned reference direction
License requirements: None. |
void |
rotateLeft()
Rotates the image 90 degrees counter-clockwise.
|
void |
rotateRight()
Rotates the image 90 degrees clockwise.
|
void |
setBackgroundColor(double[] backgroundColor)
Sets the background color (RGB value) of the image.
|
void |
setBasePointChoice(ImageBaseBuilder.BasePointChoices basePoint)
License requirements: None. |
void |
setColorMode(ImageBaseBuilder.ImageColorModes colorMode)
License requirements: None. |
void |
setCornerPoints(Point3d point1,
Point3d point2,
Point3d point3,
Point3d point4)
Set the image corner points.
|
void |
setForegroundColor(double[] foregroundColor)
Sets the foreground color (RGB value) of the image.
|
void |
setImageFile(String filename)
License requirements: None. |
void |
setImageFromPart(String imageName)
Set a
ImageData object currently
stored in the part as the image used by the builder. |
void |
setImageReferencePoint1(Point imageReferencePoint1)
License requirements: None. |
void |
setImageReferencePoint2(Point imageReferencePoint2)
License requirements: None. |
void |
setImageReferencePoint3(Point imageReferencePoint3)
License requirements: None. |
void |
setInsertionPointOption(ImageBaseBuilder.InsertionPoint insertPoint)
License requirements: None. |
void |
setLockAspectRatio(boolean lockAspectRatio)
License requirements: None. |
void |
setModelReferencePoint1(Point modelReferencePoint1)
License requirements: None. |
void |
setModelReferencePoint2(Point modelReferencePoint2)
License requirements: None. |
void |
setModelReferencePoint3(Point modelReferencePoint3)
License requirements: None. |
void |
setOverallTranslucency(int overallTranslucency)
License requirements: None. |
void |
setPixelColorTolerance(int colorTolerence)
License requirements: None. |
void |
setReferenceDirectionOption(ImageBaseBuilder.ReferenceDirection referenceDirection)
License requirements: None. |
void |
setSizeOption(ImageBaseBuilder.SizeOptions sizeOption)
License requirements: None. |
void |
setTransparencyColorOption(ImageBaseBuilder.TransparencyColorFrom transparencyColorOption)
License requirements: None. |
void |
setTransparentPixelColor(double[] transparencyColor)
Sets the transparency color (RGB value) of the image.
|
void |
setUserBasePoint(Point basePoint)
License requirements: None. |
void |
setUserInsertionPoint(Point insertPoint)
License requirements: None. |
void |
setUserReferenceDirection(nxopen.Direction userDirection)
License requirements: None. |
ImageBaseBuilder.SizeOptions |
sizeOption()
Returns the size option
License requirements: None. |
ImageBaseBuilder.TransparencyColorFrom |
transparencyColorOption()
Returns the transparency color option
License requirements: None. |
Point |
userBasePoint()
Returns the user defined base point.
|
Point |
userInsertionPoint()
Returns the user defined insertion point
License requirements: None. |
nxopen.Direction |
userReferenceDirection()
Returns the user defined reference direction vector.
|
Expression |
width()
Returns the width of the image as an
Expression . |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
ImageBaseBuilder.BasePointChoices basePointChoice() throws NXException, RemoteException
ImageBaseBuilder.BasePointChoices.USER_DEFINED
,
use setUserBasePoint(nxopen.Point)
to set a point as the User-Defined point.
NXException
RemoteException
void setBasePointChoice(ImageBaseBuilder.BasePointChoices basePoint) throws NXException, RemoteException
basePoint
- NXException
RemoteException
Point userBasePoint() throws NXException, RemoteException
basePointChoice()
is set to
ImageBaseBuilder.BasePointChoices.USER_DEFINED
.
NXException
RemoteException
void setUserBasePoint(Point basePoint) throws NXException, RemoteException
basePoint
- NXException
RemoteException
ImageBaseBuilder.InsertionPoint insertionPointOption() throws NXException, RemoteException
NXException
RemoteException
void setInsertionPointOption(ImageBaseBuilder.InsertionPoint insertPoint) throws NXException, RemoteException
insertPoint
- NXException
RemoteException
Point userInsertionPoint() throws NXException, RemoteException
NXException
RemoteException
void setUserInsertionPoint(Point insertPoint) throws NXException, RemoteException
insertPoint
- NXException
RemoteException
ImageBaseBuilder.ReferenceDirection referenceDirectionOption() throws NXException, RemoteException
ImageBaseBuilder.ReferenceDirection.HORIZONTAL
means rotate the image to align its horizontal direction with the user-specified
reference direction (if defined).
NXException
RemoteException
void setReferenceDirectionOption(ImageBaseBuilder.ReferenceDirection referenceDirection) throws NXException, RemoteException
referenceDirection
- NXException
RemoteException
nxopen.Direction userReferenceDirection() throws NXException, RemoteException
NXException
RemoteException
void setUserReferenceDirection(nxopen.Direction userDirection) throws NXException, RemoteException
userDirection
- NXException
RemoteException
void alignImageToReferenceDirection() throws NXException, RemoteException
NXException
RemoteException
Expression rotateAngleOfReferenceVector() throws NXException, RemoteException
NXException
RemoteException
void rotateLeft() throws NXException, RemoteException
NXException
RemoteException
void rotateRight() throws NXException, RemoteException
NXException
RemoteException
void flipHorizontal() throws NXException, RemoteException
NXException
RemoteException
void flipVertical() throws NXException, RemoteException
NXException
RemoteException
void orientViewToImage() throws NXException, RemoteException
NXException
RemoteException
String imageFile() throws NXException, RemoteException
NXException
RemoteException
void setImageFile(String filename) throws NXException, RemoteException
filename
- NXException
RemoteException
String[] getImagesInPart() throws NXException, RemoteException
ImageData
objects saved in current part file.
ImageData
namesNXException
RemoteException
void setImageFromPart(String imageName) throws NXException, RemoteException
ImageData
object currently
stored in the part as the image used by the builder.
imageName
- Name of ImageData
objectNXException
RemoteException
ImageBaseBuilder.CornerPointsData getCornerPoints() throws NXException, RemoteException
NXException
RemoteException
void setCornerPoints(Point3d point1, Point3d point2, Point3d point3, Point3d point4) throws NXException, RemoteException
point1
- first corner point of imagepoint2
- second corner point of imagepoint3
- third corner point of imagepoint4
- fourth corner point of imageNXException
RemoteException
ImageBaseBuilder.TransparencyColorFrom transparencyColorOption() throws NXException, RemoteException
NXException
RemoteException
void setTransparencyColorOption(ImageBaseBuilder.TransparencyColorFrom transparencyColorOption) throws NXException, RemoteException
transparencyColorOption
- NXException
RemoteException
double[] getTransparentPixelColor() throws NXException, RemoteException
transparencyColorOption()
is set to ImageBaseBuilder.TransparencyColorFrom.PIXEL_COLOR
.
The length of the output array will always be 3. Each color value of
the double array is in the range 0.0 to 1.0.
NXException
RemoteException
void setTransparentPixelColor(double[] transparencyColor) throws NXException, RemoteException
transparencyColorOption()
is set to ImageBaseBuilder.TransparencyColorFrom.PIXEL_COLOR
.
The length of the input array should always be 3. Each color value of
the double array must be in the range 0.0 to 1.0.
transparencyColor
- RGB color arrayNXException
RemoteException
double[] getForegroundColor() throws NXException, RemoteException
colorMode()
is set to ImageBaseBuilder.ImageColorModes.GREYSCALE
.
The length of the output array will always be 3. Each color value of
the double array is in the range 0.0 to 1.0.
NXException
RemoteException
void setForegroundColor(double[] foregroundColor) throws NXException, RemoteException
colorMode()
is set to ImageBaseBuilder.ImageColorModes.GREYSCALE
.
The length of the input array should always be 3. Each color value of
the double array must be in the range 0.0 to 1.0.
foregroundColor
- RGB color arrayNXException
RemoteException
double[] getBackgroundColor() throws NXException, RemoteException
colorMode()
is set to ImageBaseBuilder.ImageColorModes.GREYSCALE
.
The length of the output array will always be 3. Each color value of
the double array is in the range 0.0 to 1.0.
NXException
RemoteException
void setBackgroundColor(double[] backgroundColor) throws NXException, RemoteException
colorMode()
is set to ImageBaseBuilder.ImageColorModes.GREYSCALE
.
The length of the input array should always be 3. Each color value of
the double array must be in the range 0.0 to 1.0.
backgroundColor
- RGB color arrayNXException
RemoteException
boolean lockAspectRatio() throws NXException, RemoteException
NXException
RemoteException
void setLockAspectRatio(boolean lockAspectRatio) throws NXException, RemoteException
lockAspectRatio
- NXException
RemoteException
ImageBaseBuilder.SizeOptions sizeOption() throws NXException, RemoteException
NXException
RemoteException
void setSizeOption(ImageBaseBuilder.SizeOptions sizeOption) throws NXException, RemoteException
sizeOption
- NXException
RemoteException
Point imageReferencePoint1() throws NXException, RemoteException
sizeOption()
is set to
ImageBaseBuilder.SizeOptions.REFERENCE_SCALING
.
Reference Scaling provides sizing the image by defining image reference
points and matching them with corresponding model reference points.
NXException
RemoteException
void setImageReferencePoint1(Point imageReferencePoint1) throws NXException, RemoteException
imageReferencePoint1
- NXException
RemoteException
Point modelReferencePoint1() throws NXException, RemoteException
sizeOption()
is set to
ImageBaseBuilder.SizeOptions.REFERENCE_SCALING
.
Reference Scaling provides sizing the image by defining image reference
points and matching them with corresponding model reference points.
NXException
RemoteException
void setModelReferencePoint1(Point modelReferencePoint1) throws NXException, RemoteException
modelReferencePoint1
- NXException
RemoteException
Point imageReferencePoint2() throws NXException, RemoteException
sizeOption()
is set to
ImageBaseBuilder.SizeOptions.REFERENCE_SCALING
.
Reference Scaling provides sizing the image by defining image reference
points and matching them with corresponding model reference points.
NXException
RemoteException
void setImageReferencePoint2(Point imageReferencePoint2) throws NXException, RemoteException
imageReferencePoint2
- NXException
RemoteException
Point modelReferencePoint2() throws NXException, RemoteException
sizeOption()
is set to
ImageBaseBuilder.SizeOptions.REFERENCE_SCALING
.
Reference Scaling provides sizing the image by defining image reference
points and matching them with corresponding model reference points.
NXException
RemoteException
void setModelReferencePoint2(Point modelReferencePoint2) throws NXException, RemoteException
modelReferencePoint2
- NXException
RemoteException
Point imageReferencePoint3() throws NXException, RemoteException
sizeOption()
is set to
ImageBaseBuilder.SizeOptions.REFERENCE_SCALING
and lockAspectRatio()
is False.
Reference Scaling provides sizing the image by defining image reference
points and matching them with corresponding model reference points.
NXException
RemoteException
void setImageReferencePoint3(Point imageReferencePoint3) throws NXException, RemoteException
imageReferencePoint3
- NXException
RemoteException
Point modelReferencePoint3() throws NXException, RemoteException
sizeOption()
is set to
ImageBaseBuilder.SizeOptions.REFERENCE_SCALING
and lockAspectRatio()
is False.
Reference Scaling provides sizing the image by defining image reference
points and matching them with corresponding model reference points.
NXException
RemoteException
void setModelReferencePoint3(Point modelReferencePoint3) throws NXException, RemoteException
modelReferencePoint3
- NXException
RemoteException
Expression width() throws NXException, RemoteException
Expression
.
The returned Expression
is not associative to this object.
When sizeOption()
is set to ImageBaseBuilder.SizeOptions.USER_DEFINED
,
set the size of the image using setCornerPoints(nxopen.Point3d, nxopen.Point3d, nxopen.Point3d, nxopen.Point3d)
.
NXException
RemoteException
Expression height() throws NXException, RemoteException
Expression
.
The returned Expression
is not associative to this object.
When sizeOption()
is set to ImageBaseBuilder.SizeOptions.USER_DEFINED
,
set the size of the image using setCornerPoints(nxopen.Point3d, nxopen.Point3d, nxopen.Point3d, nxopen.Point3d)
.
NXException
RemoteException
void resetImageSize() throws NXException, RemoteException
NXException
RemoteException
int pixelColorTolerance() throws NXException, RemoteException
NXException
RemoteException
void setPixelColorTolerance(int colorTolerence) throws NXException, RemoteException
colorTolerence
- NXException
RemoteException
int overallTranslucency() throws NXException, RemoteException
NXException
RemoteException
void setOverallTranslucency(int overallTranslucency) throws NXException, RemoteException
overallTranslucency
- NXException
RemoteException
ImageBaseBuilder.ImageColorModes colorMode() throws NXException, RemoteException
NXException
RemoteException
void setColorMode(ImageBaseBuilder.ImageColorModes colorMode) throws NXException, RemoteException
colorMode
- NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.