RasterImageBuilder Class¶
-
class
NXOpen.Display.RasterImageBuilder¶ Bases:
NXOpen.Display.ImageBaseBuilderRepresents a
NXOpen.Display.RasterImageBuilder.NXOpen.Display.RasterImageprovides placing an imported image onto a plane (with controls for orientation, sizing, and display) to use as a reference in the model to create geometry.To create a new instance of this class, use
NXOpen.Display.ImageCollection.CreateRasterImageBuilder()Default values.
Property Value BasePointChoice BottomLeft ColorMode Rgb InsertionPointOption Default LockAspectRatio 1 OverallTranslucency 0 PixelColorTolerance 32 ReferenceDirectionOption Horizontal SizeOption UserDefined TransparencyColorOption None New in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| BasePointChoice | Returns or sets the image reference base point choice. |
| ColorMode | Returns or sets the color mode to display the image. |
| Height | Returns the height of the image as an NXOpen.Expression. The returned NXOpen.Expression is **not</b> associative to this object. |
| ImageFile | Returns or sets the image file |
| ImageReferencePoint1 | Returns or sets the image reference point1. Only valid when NXOpen.Display.ImageBaseBuilder.SizeOption() is set to NXOpen.Display.ImageBaseBuilderSizeOptions.ReferenceScaling. |
| ImageReferencePoint2 | Returns or sets the image reference point2. Only valid when NXOpen.Display.ImageBaseBuilder.SizeOption() is set to NXOpen.Display.ImageBaseBuilderSizeOptions.ReferenceScaling. |
| ImageReferencePoint3 | Returns or sets the image reference point3. Only valid when NXOpen.Display.ImageBaseBuilder.SizeOption() is set to NXOpen.Display.ImageBaseBuilderSizeOptions.ReferenceScaling and NXOpen.Display.ImageBaseBuilder.LockAspectRatio() is False. |
| InsertionPointOption | Returns or sets the image insertion point type |
| LockAspectRatio | Returns or sets the lock aspect ratio |
| ModelReferencePoint1 | Returns or sets the model reference point1. Only valid when NXOpen.Display.ImageBaseBuilder.SizeOption() is set to NXOpen.Display.ImageBaseBuilderSizeOptions.ReferenceScaling. |
| ModelReferencePoint2 | Returns or sets the model reference point2. Only valid when NXOpen.Display.ImageBaseBuilder.SizeOption() is set to NXOpen.Display.ImageBaseBuilderSizeOptions.ReferenceScaling. |
| ModelReferencePoint3 | Returns or sets the model reference point3. Only valid when NXOpen.Display.ImageBaseBuilder.SizeOption() is set to NXOpen.Display.ImageBaseBuilderSizeOptions.ReferenceScaling and NXOpen.Display.ImageBaseBuilder.LockAspectRatio() is False. |
| OverallTranslucency | Returns or sets the overall translucency. |
| PixelColorTolerance | Returns or sets the transparency pixel color tolerance. |
| ReferenceDirectionOption | Returns or sets the image alignment reference direction type. |
| RotateAngleOfReferenceVector | Returns the current rotation angle of image from aligned reference direction |
| SizeOption | Returns or sets the size option |
| Tag | Returns the Tag for this object. |
| Target | Returns or sets the plane the raster image is placed onto |
| TransparencyColorOption | Returns or sets the transparency color option |
| UserBasePoint | Returns or sets the user defined base point. Only valid when NXOpen.Display.ImageBaseBuilder.BasePointChoice() is set to NXOpen.Display.ImageBaseBuilderBasePointChoices.UserDefined. |
| UserInsertionPoint | Returns or sets the user defined insertion point |
| UserReferenceDirection | Returns or sets the user defined reference direction vector. |
| Width | Returns the width of the image as an NXOpen.Expression. The returned NXOpen.Expression is **not</b> associative to this object. |
Methods¶
| Method | Description |
|---|---|
| AlignImageToReferenceDirection | Align Image to Reference Direction |
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| FlipHorizontal | Flips the image horizontally. |
| FlipVertical | Flips the image vertically. |
| GetBackgroundColor | Gets the background color (RGB value) of the image. Only valid when NXOpen.Display.ImageBaseBuilder.ColorMode() is set to NXOpen.Display.ImageBaseBuilderImageColorModes.Greyscale. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetCornerPoints | Get the image corner points. |
| GetForegroundColor | Gets the foreground color (RGB value) of the image. Only valid when NXOpen.Display.ImageBaseBuilder.ColorMode() is set to NXOpen.Display.ImageBaseBuilderImageColorModes.Greyscale. |
| GetImagesInPart | Provide a list of names of the NXOpen.Display.ImageData objects saved in current part file. |
| GetObject | Returns the object currently being edited by this builder. |
| GetTransparentPixelColor | Gets the transparency color (RGB value) of the image. Only valid when NXOpen.Display.ImageBaseBuilder.TransparencyColorOption() is set to NXOpen.Display.ImageBaseBuilderTransparencyColorFrom.PixelColor. |
| OrientViewToImage | Orients and fits the work view’s view direction along the reverse normal direction of the image |
| ResetImageSize | Resets the image to its original size. |
| RotateLeft | Rotates the image 90 degrees counter-clockwise. |
| RotateRight | Rotates the image 90 degrees clockwise. |
| SetBackgroundColor | Sets the background color (RGB value) of the image. Only valid when NXOpen.Display.ImageBaseBuilder.ColorMode() is set to NXOpen.Display.ImageBaseBuilderImageColorModes.Greyscale. |
| SetCornerPoints | Set the image corner points. |
| SetForegroundColor | Sets the foreground color (RGB value) of the image. Only valid when NXOpen.Display.ImageBaseBuilder.ColorMode() is set to NXOpen.Display.ImageBaseBuilderImageColorModes.Greyscale. |
| SetImageFromPart | Set a NXOpen.Display.ImageData object currently stored in the part as the image used by the builder. |
| SetTransparentPixelColor | Sets the transparency color (RGB value) of the image. Only valid when NXOpen.Display.ImageBaseBuilder.TransparencyColorOption() is set to NXOpen.Display.ImageBaseBuilderTransparencyColorFrom.PixelColor. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
Target¶
-
RasterImageBuilder.Target¶ Returns or sets the plane the raster image is placed onto
-------------------------------------Getter Method
Signature
TargetReturns: Return type: NXOpen.PlaneNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TargetParameters: targetObject ( NXOpen.Plane) –New in version NX9.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
RasterImageBuilder.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.