Represents a NXOpen.Display.ImageBaseBuilder . More...

Inheritance diagram for NXOpen.Display.ImageBaseBuilder:

Public Types
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
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...

Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject	Commit ()
	Commits any edits that have been applied to the builder. More...

unsafe void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
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
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents a NXOpen.Display.ImageBaseBuilder .

Serves as the base class for all NXOpen.Display.ImageBase builders. NXOpen.Display.ImageBase base class provides definition, orientation, sizing, and display setting controls for image based objects.

This is an abstract class, and cannot be instantiated.

Created in NX9.0.0

Member Enumeration Documentation

enum NXOpen.Display.ImageBaseBuilder.BasePointChoices

Specifies image reference base point choice.

Enumerator
BottomLeft	bottom left
BottomCenter	bottom center
BottomRight	bottom left
MiddleLeft	middle left
MiddleCenter	middle center
MiddleRight	middle right
TopLeft	top left
TopCenter	top center
TopRight	top right
UserDefined	user defined

enum NXOpen.Display.ImageBaseBuilder.ImageColorModes

Describes image color modes.

Enumerator
Rgb	rgb color mode
Greyscale	grey scale color mode
Monochrome	monochrome color mode

enum NXOpen.Display.ImageBaseBuilder.InsertionPoint

Describes insertion point type.

Enumerator
Default	default insertion point type
UserDefined	user defined insertion point type

enum NXOpen.Display.ImageBaseBuilder.ReferenceDirection

Specifies image alignment reference direction type.

Enumerator
Horizontal	horizontal reference direction
Vertical	vertical reference direction

enum NXOpen.Display.ImageBaseBuilder.SizeOptions

Describes size options.

Enumerator
UserDefined	user defined option
ImageSize	image size option
ReferenceScaling	reference scaling option

enum NXOpen.Display.ImageBaseBuilder.TransparencyColorFrom

Transparency Color From

Enumerator
None	No Transparency Color
FromImage	Transparency Color from image
PixelColor

Member Function Documentation

unsafe void NXOpen.Display.ImageBaseBuilder.AlignImageToReferenceDirection ( )

inline

Align Image to Reference Direction

Created in NX9.0.0

License requirements: None.

unsafe void NXOpen.Display.ImageBaseBuilder.FlipHorizontal ( )

inline

Flips the image horizontally.

Created in NX9.0.0

License requirements: None.

unsafe void NXOpen.Display.ImageBaseBuilder.FlipVertical ( )

inline

Flips the image vertically.

Created in NX9.0.0

License requirements: None.

unsafe double [] NXOpen.Display.ImageBaseBuilder.GetBackgroundColor ( )

inline

Gets the background color (RGB value) of the image.

Only valid when NXOpen.Display.ImageBaseBuilder.ColorMode is set to NXOpen.Display.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.

Created in NX9.0.0

License requirements: None.

Returns: RGB color array

unsafe void NXOpen.Display.ImageBaseBuilder.GetCornerPoints	(	out NXOpen.Point3d	point1,
		out NXOpen.Point3d	point2,
		out NXOpen.Point3d	point3,
		out NXOpen.Point3d	point4
	)

inline

Get the image corner points.

The points define a rectangular region and are ordered counter-clockwise.

Created in NX9.0.0

License requirements: None.

Parameters

point1	first corner point of image
point2	second corner point of image
point3	third corner point of image
point4	fourth corner point of image

unsafe double [] NXOpen.Display.ImageBaseBuilder.GetForegroundColor ( )

inline

Gets the foreground color (RGB value) of the image.

Only valid when NXOpen.Display.ImageBaseBuilder.ColorMode is set to NXOpen.Display.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.

Created in NX9.0.0

License requirements: None.

Returns: RGB color array

unsafe string [] NXOpen.Display.ImageBaseBuilder.GetImagesInPart ( )

inline

Provide a list of names of the NXOpen.Display.ImageData objects saved in current part file.

Created in NX9.0.0

License requirements: None.

Returns: Array of NXOpen.Display.ImageData names

unsafe double [] NXOpen.Display.ImageBaseBuilder.GetTransparentPixelColor ( )

inline

Gets the transparency color (RGB value) of the image.

Only valid when NXOpen.Display.ImageBaseBuilder.TransparencyColorOption is set to NXOpen.Display.ImageBaseBuilder.TransparencyColorFrom.PixelColor .

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.

Created in NX9.0.0

License requirements: None.

Returns: RGB color array

unsafe void NXOpen.Display.ImageBaseBuilder.OrientViewToImage ( )

inline

Orients and fits the work view's view direction along the reverse normal direction of the image

Created in NX9.0.0

License requirements: None.

unsafe void NXOpen.Display.ImageBaseBuilder.ResetImageSize ( )

inline

Resets the image to its original size.

Created in NX9.0.0

License requirements: None.

unsafe void NXOpen.Display.ImageBaseBuilder.RotateLeft ( )

inline

Rotates the image 90 degrees counter-clockwise.

Created in NX9.0.0

License requirements: None.

unsafe void NXOpen.Display.ImageBaseBuilder.RotateRight ( )

inline

Rotates the image 90 degrees clockwise.

Created in NX9.0.0

License requirements: None.

unsafe void NXOpen.Display.ImageBaseBuilder.SetBackgroundColor ( double[] backgroundColor )

inline

Sets the background color (RGB value) of the image.

Only valid when NXOpen.Display.ImageBaseBuilder.ColorMode is set to NXOpen.Display.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.

Created in NX9.0.0

License requirements: None.

Parameters

backgroundColor RGB color array

unsafe void NXOpen.Display.ImageBaseBuilder.SetCornerPoints	(	NXOpen.Point3d	point1,
		NXOpen.Point3d	point2,
		NXOpen.Point3d	point3,
		NXOpen.Point3d	point4
	)

inline

Set the image corner points.

The points must define a rectangular region and be ordered counter-clockwise.

Created in NX9.0.0

License requirements: None.

Parameters

point1	first corner point of image
point2	second corner point of image
point3	third corner point of image
point4	fourth corner point of image

unsafe void NXOpen.Display.ImageBaseBuilder.SetForegroundColor ( double[] foregroundColor )

inline

Sets the foreground color (RGB value) of the image.

Only valid when NXOpen.Display.ImageBaseBuilder.ColorMode is set to NXOpen.Display.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.

Created in NX9.0.0

License requirements: None.

Parameters

foregroundColor RGB color array

unsafe void NXOpen.Display.ImageBaseBuilder.SetImageFromPart ( string imageName )

inline

Set a NXOpen.Display.ImageData object currently stored in the part as the image used by the builder.

Created in NX9.0.0

License requirements: None.

Parameters

imageName Name of NXOpen.Display.ImageData object

unsafe void NXOpen.Display.ImageBaseBuilder.SetTransparentPixelColor ( double[] transparencyColor )

inline

Sets the transparency color (RGB value) of the image.

Only valid when NXOpen.Display.ImageBaseBuilder.TransparencyColorOption is set to NXOpen.Display.ImageBaseBuilder.TransparencyColorFrom.PixelColor .

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.

Created in NX9.0.0

License requirements: None.

Parameters

transparencyColor RGB color array

Property Documentation

unsafe NXOpen.Display.ImageBaseBuilder.BasePointChoices NXOpen.Display.ImageBaseBuilder.BasePointChoice

getset

Returns or sets the image reference base point choice.

If you choose NXOpen.Display.ImageBaseBuilder.BasePointChoices.UserDefined , use NXOpen.Display.ImageBaseBuilder.UserBasePoint to set a point as the User-Defined point.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.ImageBaseBuilder.ImageColorModes NXOpen.Display.ImageBaseBuilder.ColorMode

getset

Returns or sets the color mode to display the image.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Expression NXOpen.Display.ImageBaseBuilder.Height

get

Returns the height of the image as an NXOpen.Expression .

The returned NXOpen.Expression is not associative to this object.

When NXOpen.Display.ImageBaseBuilder.SizeOption is set to NXOpen.Display.ImageBaseBuilder.SizeOptions.UserDefined , set the size of the image using NXOpen.Display.ImageBaseBuilder.SetCornerPoints .

Created in NX9.0.0

License requirements: None.

unsafe string NXOpen.Display.ImageBaseBuilder.ImageFile

getset

Returns or sets the image file

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point NXOpen.Display.ImageBaseBuilder.ImageReferencePoint1

getset

Returns or sets the image reference point1.

Only valid when NXOpen.Display.ImageBaseBuilder.SizeOption is set to NXOpen.Display.ImageBaseBuilder.SizeOptions.ReferenceScaling .

Reference Scaling provides sizing the image by defining image reference points and matching them with corresponding model reference points.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point NXOpen.Display.ImageBaseBuilder.ImageReferencePoint2

getset

Returns or sets the image reference point2.

Only valid when NXOpen.Display.ImageBaseBuilder.SizeOption is set to NXOpen.Display.ImageBaseBuilder.SizeOptions.ReferenceScaling .

Reference Scaling provides sizing the image by defining image reference points and matching them with corresponding model reference points.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point NXOpen.Display.ImageBaseBuilder.ImageReferencePoint3

getset

Returns or sets the image reference point3.

Only valid when NXOpen.Display.ImageBaseBuilder.SizeOption is set to NXOpen.Display.ImageBaseBuilder.SizeOptions.ReferenceScaling and NXOpen.Display.ImageBaseBuilder.LockAspectRatio is False.

Reference Scaling provides sizing the image by defining image reference points and matching them with corresponding model reference points.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point3d NXOpen.Display.ImageBaseBuilder.InsertionPointLocation

getset

Returns or sets the insertion point of the image

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.ImageBaseBuilder.InsertionPoint NXOpen.Display.ImageBaseBuilder.InsertionPointOption

getset

Returns or sets the image insertion point type

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.ImageBaseBuilder.LockAspectRatio

getset

Returns or sets the lock aspect ratio

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point NXOpen.Display.ImageBaseBuilder.ModelReferencePoint1

getset

Returns or sets the model reference point1.

Only valid when NXOpen.Display.ImageBaseBuilder.SizeOption is set to NXOpen.Display.ImageBaseBuilder.SizeOptions.ReferenceScaling .

Reference Scaling provides sizing the image by defining image reference points and matching them with corresponding model reference points.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point NXOpen.Display.ImageBaseBuilder.ModelReferencePoint2

getset

Returns or sets the model reference point2.

Only valid when NXOpen.Display.ImageBaseBuilder.SizeOption is set to NXOpen.Display.ImageBaseBuilder.SizeOptions.ReferenceScaling .

Reference Scaling provides sizing the image by defining image reference points and matching them with corresponding model reference points.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point NXOpen.Display.ImageBaseBuilder.ModelReferencePoint3

getset

Returns or sets the model reference point3.

Only valid when NXOpen.Display.ImageBaseBuilder.SizeOption is set to NXOpen.Display.ImageBaseBuilder.SizeOptions.ReferenceScaling and NXOpen.Display.ImageBaseBuilder.LockAspectRatio is False.

Reference Scaling provides sizing the image by defining image reference points and matching them with corresponding model reference points.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Display.ImageBaseBuilder.OverallTranslucency

getset

Returns or sets the overall translucency.

The range of this value is 0 to 100.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Display.ImageBaseBuilder.PixelColorTolerance

getset

Returns or sets the transparency pixel color tolerance.

The range of this value is 0 to 255.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.ImageBaseBuilder.ReferenceDirection NXOpen.Display.ImageBaseBuilder.ReferenceDirectionOption

getset

Returns or sets the image alignment reference direction type.

NXOpen.Display.ImageBaseBuilder.ReferenceDirection.Horizontal means rotate the image to align its horizontal direction with the user-specified reference direction (if defined).

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Expression NXOpen.Display.ImageBaseBuilder.RotateAngleOfReferenceVector

get

Returns the current rotation angle of image from aligned reference direction

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.Display.ImageBaseBuilder.SizeOptions NXOpen.Display.ImageBaseBuilder.SizeOption

getset

Returns or sets the size option

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.ImageBaseBuilder.TransparencyColorFrom NXOpen.Display.ImageBaseBuilder.TransparencyColorOption

getset

Returns or sets the transparency color option

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point NXOpen.Display.ImageBaseBuilder.UserBasePoint

getset

Returns or sets the user defined base point.

Only valid when NXOpen.Display.ImageBaseBuilder.BasePointChoice is set to NXOpen.Display.ImageBaseBuilder.BasePointChoices.UserDefined .

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point NXOpen.Display.ImageBaseBuilder.UserInsertionPoint

getset

Returns or sets the user defined insertion point

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Direction NXOpen.Display.ImageBaseBuilder.UserReferenceDirection

getset

Returns or sets the user defined reference direction vector.

A direction normal to the plane of the image is invalid.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Expression NXOpen.Display.ImageBaseBuilder.Width

get

Returns the width of the image as an NXOpen.Expression .

The returned NXOpen.Expression is not associative to this object.

When NXOpen.Display.ImageBaseBuilder.SizeOption is set to NXOpen.Display.ImageBaseBuilder.SizeOptions.UserDefined , set the size of the image using NXOpen.Display.ImageBaseBuilder.SetCornerPoints .

Created in NX9.0.0

License requirements: None.

The documentation for this class was generated from the following file:

Display_ImageBaseBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation