NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Properties | List of all members
NXOpen.Display.RasterImageBuilder Class Reference

Represents a NXOpen.Display.RasterImageBuilder . More...

Inheritance diagram for NXOpen.Display.RasterImageBuilder:
NXOpen.Display.ImageBaseBuilder NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Properties

unsafe NXOpen.Plane Target [get, set]
 Returns or sets the plane the raster image is placed onto More...
 
- Properties inherited from NXOpen.Display.ImageBaseBuilder
unsafe
NXOpen.Display.ImageBaseBuilder.BasePointChoices 
BasePointChoice [get, set]
 Returns or sets the image reference base point choice. More...
 
unsafe
NXOpen.Display.ImageBaseBuilder.ImageColorModes 
ColorMode [get, set]
 Returns or sets the color mode to display the image. More...
 
unsafe NXOpen.Expression Height [get]
 Returns the height of the image as an NXOpen.Expression . More...
 
unsafe string ImageFile [get, set]
 Returns or sets the image file More...
 
unsafe NXOpen.Point ImageReferencePoint1 [get, set]
 Returns or sets the image reference point1. More...
 
unsafe NXOpen.Point ImageReferencePoint2 [get, set]
 Returns or sets the image reference point2. More...
 
unsafe NXOpen.Point ImageReferencePoint3 [get, set]
 Returns or sets the image reference point3. More...
 
unsafe NXOpen.Point3d InsertionPointLocation [get, set]
 Returns or sets the insertion point of the image More...
 
unsafe
NXOpen.Display.ImageBaseBuilder.InsertionPoint 
InsertionPointOption [get, set]
 Returns or sets the image insertion point type More...
 
unsafe bool LockAspectRatio [get, set]
 Returns or sets the lock aspect ratio More...
 
unsafe NXOpen.Point ModelReferencePoint1 [get, set]
 Returns or sets the model reference point1. More...
 
unsafe NXOpen.Point ModelReferencePoint2 [get, set]
 Returns or sets the model reference point2. More...
 
unsafe NXOpen.Point ModelReferencePoint3 [get, set]
 Returns or sets the model reference point3. More...
 
unsafe int OverallTranslucency [get, set]
 Returns or sets the overall translucency. More...
 
unsafe int PixelColorTolerance [get, set]
 Returns or sets the transparency pixel color tolerance. More...
 
unsafe
NXOpen.Display.ImageBaseBuilder.ReferenceDirection 
ReferenceDirectionOption [get, set]
 Returns or sets the image alignment reference direction type. More...
 
unsafe NXOpen.Expression RotateAngleOfReferenceVector [get]
 Returns the current rotation angle of image from aligned reference direction More...
 
unsafe
NXOpen.Display.ImageBaseBuilder.SizeOptions 
SizeOption [get, set]
 Returns or sets the size option More...
 
unsafe
NXOpen.Display.ImageBaseBuilder.TransparencyColorFrom 
TransparencyColorOption [get, set]
 Returns or sets the transparency color option More...
 
unsafe NXOpen.Point UserBasePoint [get, set]
 Returns or sets the user defined base point. More...
 
unsafe NXOpen.Point UserInsertionPoint [get, set]
 Returns or sets the user defined insertion point More...
 
unsafe NXOpen.Direction UserReferenceDirection [get, set]
 Returns or sets the user defined reference direction vector. More...
 
unsafe NXOpen.Expression Width [get]
 Returns the width of the image as an NXOpen.Expression . More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Public Types inherited from NXOpen.Display.ImageBaseBuilder
enum  BasePointChoices {
  BottomLeft, BottomCenter, BottomRight, MiddleLeft,
  MiddleCenter, MiddleRight, TopLeft, TopCenter,
  TopRight, UserDefined
}
 Specifies image reference base point choice. More...
 
enum  ImageColorModes { Rgb, Greyscale, Monochrome }
 Describes image color modes. More...
 
enum  InsertionPoint { Default, UserDefined }
 Describes insertion point type. More...
 
enum  ReferenceDirection { Horizontal, Vertical }
 Specifies image alignment reference direction type. More...
 
enum  SizeOptions { UserDefined, ImageSize, ReferenceScaling }
 Describes size options. More...
 
enum  TransparencyColorFrom { None, FromImage, PixelColor }
 Transparency Color From More...
 
- Public Member Functions inherited from NXOpen.Display.ImageBaseBuilder
unsafe void AlignImageToReferenceDirection ()
 Align Image to Reference Direction More...
 
unsafe void FlipHorizontal ()
 Flips the image horizontally. More...
 
unsafe void FlipVertical ()
 Flips the image vertically. More...
 
unsafe double[] GetBackgroundColor ()
 Gets the background color (RGB value) of the image. More...
 
unsafe void GetCornerPoints (out NXOpen.Point3d point1, out NXOpen.Point3d point2, out NXOpen.Point3d point3, out NXOpen.Point3d point4)
 Get the image corner points. More...
 
unsafe double[] GetForegroundColor ()
 Gets the foreground color (RGB value) of the image. More...
 
unsafe string[] GetImagesInPart ()
 Provide a list of names of the NXOpen.Display.ImageData objects saved in current part file. More...
 
unsafe double[] GetTransparentPixelColor ()
 Gets the transparency color (RGB value) of the image. More...
 
unsafe void OrientViewToImage ()
 Orients and fits the work view's view direction along the reverse normal direction of the image More...
 
unsafe void ResetImageSize ()
 Resets the image to its original size. More...
 
unsafe void RotateLeft ()
 Rotates the image 90 degrees counter-clockwise. More...
 
unsafe void RotateRight ()
 Rotates the image 90 degrees clockwise. More...
 
unsafe void SetBackgroundColor (double[] backgroundColor)
 Sets the background color (RGB value) of the image. More...
 
unsafe void SetCornerPoints (NXOpen.Point3d point1, NXOpen.Point3d point2, NXOpen.Point3d point3, NXOpen.Point3d point4)
 Set the image corner points. More...
 
unsafe void SetForegroundColor (double[] foregroundColor)
 Sets the foreground color (RGB value) of the image. More...
 
unsafe void SetImageFromPart (string imageName)
 Set a NXOpen.Display.ImageData object currently stored in the part as the image used by the builder. More...
 
unsafe void SetTransparentPixelColor (double[] transparencyColor)
 Sets the transparency color (RGB value) of the image. More...
 
- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.Display.RasterImageBuilder .

NXOpen.Display.RasterImage provides 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

Created in NX9.0.0

Property Documentation

unsafe NXOpen.Plane NXOpen.Display.RasterImageBuilder.Target
getset

Returns or sets the plane the raster image is placed onto

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.