Represents a Display::ImageBaseBuilder . More...

Inheritance diagram for NXOpen::Display::ImageBaseBuilder:

Public Types
enum	BasePointChoices { BasePointChoicesBottomLeft, BasePointChoicesBottomCenter, BasePointChoicesBottomRight, BasePointChoicesMiddleLeft, BasePointChoicesMiddleCenter, BasePointChoicesMiddleRight, BasePointChoicesTopLeft, BasePointChoicesTopCenter, BasePointChoicesTopRight, BasePointChoicesUserDefined }
	Specifies image reference base point choice. More...

enum	ImageColorModes { ImageColorModesRgb, ImageColorModesGreyscale, ImageColorModesMonochrome }
	Describes image color modes. More...

enum	InsertionPoint { InsertionPointDefault, InsertionPointUserDefined }
	Describes insertion point type. More...

enum	ReferenceDirection { ReferenceDirectionHorizontal, ReferenceDirectionVertical }
	Specifies image alignment reference direction type. More...

enum	SizeOptions { SizeOptionsUserDefined, SizeOptionsImageSize, SizeOptionsReferenceScaling }
	Describes size options. More...

enum	TransparencyColorFrom { TransparencyColorFromNone, TransparencyColorFromFromImage, TransparencyColorFromPixelColor }
	Transparency Color From. More...

Public Member Functions
void	AlignImageToReferenceDirection ()
	Align Image to Reference Direction Created in NX9.0.0.

NXOpen::Display::ImageBaseBuilder::BasePointChoices	BasePointChoice ()
	Returns the image reference base point choice.

NXOpen::Display::ImageBaseBuilder::ImageColorModes	ColorMode ()
	Returns the color mode to display the image.

void	FlipHorizontal ()
	Flips the image horizontally.

void	FlipVertical ()
	Flips the image vertically.

std::vector< double >	GetBackgroundColor ()
	Gets the background color (RGB value) of the image; only valid when Display::ImageBaseBuilder::ColorMode and Display::ImageBaseBuilder::SetColorMode is set to Display::ImageBaseBuilder::ImageColorModesGreyscale .

void	GetCornerPoints (NXOpen::Point3d point1, NXOpen::Point3d point2, NXOpen::Point3d point3, NXOpen::Point3d point4)
	Get the image corner points.

std::vector< double >	GetForegroundColor ()
	Gets the foreground color (RGB value) of the image; only valid when Display::ImageBaseBuilder::ColorMode and Display::ImageBaseBuilder::SetColorMode is set to Display::ImageBaseBuilder::ImageColorModesGreyscale .

std::vector< NXString >	GetImagesInPart ()
	Provide a list of names of the Display::ImageData objects saved in current part file.

std::vector< double >	GetTransparentPixelColor ()
	Gets the transparency color (RGB value) of the image; only valid when Display::ImageBaseBuilder::TransparencyColorOption and Display::ImageBaseBuilder::SetTransparencyColorOption is set to Display::ImageBaseBuilder::TransparencyColorFromPixelColor .

NXOpen::Expression *	Height ()
	Returns the height of the image as an expression.

NXString	ImageFile ()
	Returns the image file Created in NX9.0.0.

NXOpen::Point *	ImageReferencePoint1 ()
	Returns the image reference point1; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

NXOpen::Point *	ImageReferencePoint2 ()
	Returns the image reference point2; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

NXOpen::Point *	ImageReferencePoint3 ()
	Returns the image reference point3; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling and Display::ImageBaseBuilder::LockAspectRatio and Display::ImageBaseBuilder::SetLockAspectRatio is set to False.

NXOpen::Display::ImageBaseBuilder::InsertionPoint	InsertionPointOption ()
	Returns the image insertion point type Created in NX9.0.0.

bool	LockAspectRatio ()
	Returns the lock aspect ratio Created in NX9.0.0.

NXOpen::Point *	ModelReferencePoint1 ()
	Returns the model reference point1; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

NXOpen::Point *	ModelReferencePoint2 ()
	Returns the model reference point2; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

NXOpen::Point *	ModelReferencePoint3 ()
	Returns the model reference point3; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling and Display::ImageBaseBuilder::LockAspectRatio and Display::ImageBaseBuilder::SetLockAspectRatio is set to False.

void	OrientViewToImage ()
	Orients and fits the work view's view direction along the reverse normal direction of the image Created in NX9.0.0.

int	OverallTranslucency ()
	Returns the overall translucency.

int	PixelColorTolerance ()
	Returns the transparency pixel color tolerance.

NXOpen::Display::ImageBaseBuilder::ReferenceDirection	ReferenceDirectionOption ()
	Returns the image alignment reference direction type.

void	ResetImageSize ()
	Resets the image to its original size.

NXOpen::Expression *	RotateAngleOfReferenceVector ()
	Returns the current rotation angle of image from aligned reference direction Created in NX9.0.0.

void	RotateLeft ()
	Rotates the image 90 degrees counter-clockwise.

void	RotateRight ()
	Rotates the image 90 degrees clockwise.

void	SetBackgroundColor (const std::vector< double > &backgroundColor)
	Sets the background color (RGB value) of the image; only valid when Display::ImageBaseBuilder::ColorMode and Display::ImageBaseBuilder::SetColorMode is set to Display::ImageBaseBuilder::ImageColorModesGreyscale .

void	SetBasePointChoice (NXOpen::Display::ImageBaseBuilder::BasePointChoices basePoint)
	Sets the image reference base point choice.

void	SetColorMode (NXOpen::Display::ImageBaseBuilder::ImageColorModes colorMode)
	Sets the color mode to display the image.

void	SetCornerPoints (const NXOpen::Point3d &point1, const NXOpen::Point3d &point2, const NXOpen::Point3d &point3, const NXOpen::Point3d &point4)
	Set the image corner points.

void	SetForegroundColor (const std::vector< double > &foregroundColor)
	Sets the foreground color (RGB value) of the image; only valid when Display::ImageBaseBuilder::ColorMode and Display::ImageBaseBuilder::SetColorMode is set to Display::ImageBaseBuilder::ImageColorModesGreyscale .

void	SetImageFile (const NXString &filename)
	Sets the image file Created in NX9.0.0.

void	SetImageFile (const char *filename)
	Sets the image file Created in NX9.0.0.

void	SetImageFromPart (const NXString &imageName)
	Set a Display::ImageData object currently stored in the part as the image used by the builder.

void	SetImageFromPart (const char *imageName)
	Set a Display::ImageData object currently stored in the part as the image used by the builder.

void	SetImageReferencePoint1 (NXOpen::Point *imageReferencePoint1)
	Sets the image reference point1; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

void	SetImageReferencePoint2 (NXOpen::Point *imageReferencePoint2)
	Sets the image reference point2; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

void	SetImageReferencePoint3 (NXOpen::Point *imageReferencePoint3)
	Sets the image reference point3; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling and Display::ImageBaseBuilder::LockAspectRatio and Display::ImageBaseBuilder::SetLockAspectRatio is set to False.

void	SetInsertionPointOption (NXOpen::Display::ImageBaseBuilder::InsertionPoint insertPoint)
	Sets the image insertion point type Created in NX9.0.0.

void	SetLockAspectRatio (bool lockAspectRatio)
	Sets the lock aspect ratio Created in NX9.0.0.

void	SetModelReferencePoint1 (NXOpen::Point *modelReferencePoint1)
	Sets the model reference point1; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

void	SetModelReferencePoint2 (NXOpen::Point *modelReferencePoint2)
	Sets the model reference point2; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

void	SetModelReferencePoint3 (NXOpen::Point *modelReferencePoint3)
	Sets the model reference point3; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling and Display::ImageBaseBuilder::LockAspectRatio and Display::ImageBaseBuilder::SetLockAspectRatio is set to False.

void	SetOverallTranslucency (int overallTranslucency)
	Sets the overall translucency.

void	SetPixelColorTolerance (int colorTolerence)
	Sets the transparency pixel color tolerance.

void	SetReferenceDirectionOption (NXOpen::Display::ImageBaseBuilder::ReferenceDirection referenceDirection)
	Sets the image alignment reference direction type.

void	SetSizeOption (NXOpen::Display::ImageBaseBuilder::SizeOptions sizeOption)
	Sets the size option Created in NX9.0.0.

void	SetTransparencyColorOption (NXOpen::Display::ImageBaseBuilder::TransparencyColorFrom transparencyColorOption)
	Sets the transparency color option Created in NX9.0.0.

void	SetTransparentPixelColor (const std::vector< double > &transparencyColor)
	Sets the transparency color (RGB value) of the image; only valid when Display::ImageBaseBuilder::TransparencyColorOption and Display::ImageBaseBuilder::SetTransparencyColorOption is set to Display::ImageBaseBuilder::TransparencyColorFromPixelColor .

void	SetUserBasePoint (NXOpen::Point *basePoint)
	Sets the user defined base point.

void	SetUserInsertionPoint (NXOpen::Point *insertPoint)
	Sets the user defined insertion point Created in NX9.0.0.

void	SetUserReferenceDirection (NXOpen::Direction *userDirection)
	Sets the user defined reference direction vector.

NXOpen::Display::ImageBaseBuilder::SizeOptions	SizeOption ()
	Returns the size option Created in NX9.0.0.

NXOpen::Display::ImageBaseBuilder::TransparencyColorFrom	TransparencyColorOption ()
	Returns the transparency color option Created in NX9.0.0.

NXOpen::Point *	UserBasePoint ()
	Returns the user defined base point.

NXOpen::Point *	UserInsertionPoint ()
	Returns the user defined insertion point Created in NX9.0.0.

NXOpen::Direction *	UserReferenceDirection ()
	Returns the user defined reference direction vector.

NXOpen::Expression *	Width ()
	Returns the width of the image as an expression.

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

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

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Display::ImageBaseBuilder .

Serves as the base class for all Display::ImageBase builders. 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:

BasePointChoicesBottomLeft	bottom left
BasePointChoicesBottomCenter	bottom center
BasePointChoicesBottomRight	bottom left
BasePointChoicesMiddleLeft	middle left
BasePointChoicesMiddleCenter	middle center
BasePointChoicesMiddleRight	middle right
BasePointChoicesTopLeft	top left
BasePointChoicesTopCenter	top center
BasePointChoicesTopRight	top right
BasePointChoicesUserDefined	user defined

enum NXOpen::Display::ImageBaseBuilder::ImageColorModes

Describes image color modes.

Enumerator:

ImageColorModesRgb	rgb color mode
ImageColorModesGreyscale	grey scale color mode
ImageColorModesMonochrome	monochrome color mode

enum NXOpen::Display::ImageBaseBuilder::InsertionPoint

Describes insertion point type.

Enumerator:

InsertionPointDefault	default insertion point type
InsertionPointUserDefined	user defined insertion point type

enum NXOpen::Display::ImageBaseBuilder::ReferenceDirection

Specifies image alignment reference direction type.

Enumerator:

ReferenceDirectionHorizontal	horizontal reference direction
ReferenceDirectionVertical	vertical reference direction

enum NXOpen::Display::ImageBaseBuilder::SizeOptions

Describes size options.

Enumerator:

SizeOptionsUserDefined	user defined option
SizeOptionsImageSize	image size option
SizeOptionsReferenceScaling	reference scaling option

enum NXOpen::Display::ImageBaseBuilder::TransparencyColorFrom

Transparency Color From.

Enumerator:

TransparencyColorFromNone	No Transparency Color.
TransparencyColorFromFromImage	Transparency Color from image.
TransparencyColorFromPixelColor	pixel color

Member Function Documentation

void NXOpen::Display::ImageBaseBuilder::AlignImageToReferenceDirection ( )

Align Image to Reference Direction
Created in NX9.0.0.

License requirements : None

NXOpen::Display::ImageBaseBuilder::BasePointChoices NXOpen::Display::ImageBaseBuilder::BasePointChoice ( )

Returns the image reference base point choice.

If you choose Display::ImageBaseBuilder::BasePointChoicesUserDefined , use Display::ImageBaseBuilder::SetUserBasePoint to set a point as the User-Defined point.

Created in NX9.0.0.

License requirements : None

NXOpen::Display::ImageBaseBuilder::ImageColorModes NXOpen::Display::ImageBaseBuilder::ColorMode ( )

Returns the color mode to display the image.

Created in NX9.0.0.

License requirements : None

void NXOpen::Display::ImageBaseBuilder::FlipHorizontal ( )

Flips the image horizontally.

Created in NX9.0.0.

License requirements : None

void NXOpen::Display::ImageBaseBuilder::FlipVertical ( )

Flips the image vertically.

Created in NX9.0.0.

License requirements : None

std::vector<double> NXOpen::Display::ImageBaseBuilder::GetBackgroundColor ( )

Gets the background color (RGB value) of the image; only valid when Display::ImageBaseBuilder::ColorMode and Display::ImageBaseBuilder::SetColorMode is set to Display::ImageBaseBuilder::ImageColorModesGreyscale .

   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. 
    @return  RGB color array

Created in NX9.0.0.

License requirements : None

void NXOpen::Display::ImageBaseBuilder::GetCornerPoints	(	NXOpen::Point3d *	point1,
		NXOpen::Point3d *	point2,
		NXOpen::Point3d *	point3,
		NXOpen::Point3d *	point4
	)

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

std::vector<double> NXOpen::Display::ImageBaseBuilder::GetForegroundColor ( )

Gets the foreground color (RGB value) of the image; only valid when Display::ImageBaseBuilder::ColorMode and Display::ImageBaseBuilder::SetColorMode is set to Display::ImageBaseBuilder::ImageColorModesGreyscale .

   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. 
    @return  RGB color array

Created in NX9.0.0.

License requirements : None

std::vector<NXString> NXOpen::Display::ImageBaseBuilder::GetImagesInPart ( )

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

    @return  Array of @link Display::ImageData Display::ImageData@endlink  names

Created in NX9.0.0.

License requirements : None

std::vector<double> NXOpen::Display::ImageBaseBuilder::GetTransparentPixelColor ( )

Gets the transparency color (RGB value) of the image; only valid when Display::ImageBaseBuilder::TransparencyColorOption and Display::ImageBaseBuilder::SetTransparencyColorOption is set to Display::ImageBaseBuilder::TransparencyColorFromPixelColor .

   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. 
    @return  RGB color array

Created in NX9.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Display::ImageBaseBuilder::Height ( )

Returns the height of the image as an expression.

Created in NX9.0.0.

License requirements : None

NXString NXOpen::Display::ImageBaseBuilder::ImageFile ( )

Returns the image file
Created in NX9.0.0.

License requirements : None

NXOpen::Point* NXOpen::Display::ImageBaseBuilder::ImageReferencePoint1 ( )

Returns the image reference point1; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

   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 : None

NXOpen::Point* NXOpen::Display::ImageBaseBuilder::ImageReferencePoint2 ( )

Returns the image reference point2; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

   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 : None

NXOpen::Point* NXOpen::Display::ImageBaseBuilder::ImageReferencePoint3 ( )

Returns the image reference point3; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling and Display::ImageBaseBuilder::LockAspectRatio and Display::ImageBaseBuilder::SetLockAspectRatio is set to 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 : None

NXOpen::Display::ImageBaseBuilder::InsertionPoint NXOpen::Display::ImageBaseBuilder::InsertionPointOption ( )

Returns the image insertion point type
Created in NX9.0.0.

License requirements : None

bool NXOpen::Display::ImageBaseBuilder::LockAspectRatio ( )

Returns the lock aspect ratio
Created in NX9.0.0.

License requirements : None

NXOpen::Point* NXOpen::Display::ImageBaseBuilder::ModelReferencePoint1 ( )

Returns the model reference point1; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

   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 : None

NXOpen::Point* NXOpen::Display::ImageBaseBuilder::ModelReferencePoint2 ( )

Returns the model reference point2; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

   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 : None

NXOpen::Point* NXOpen::Display::ImageBaseBuilder::ModelReferencePoint3 ( )

Returns the model reference point3; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling and Display::ImageBaseBuilder::LockAspectRatio and Display::ImageBaseBuilder::SetLockAspectRatio is set to 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 : None

void NXOpen::Display::ImageBaseBuilder::OrientViewToImage ( )

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

int NXOpen::Display::ImageBaseBuilder::OverallTranslucency ( )

Returns the overall translucency.

The range of this value is 0 to 100.
Created in NX9.0.0.

License requirements : None

int NXOpen::Display::ImageBaseBuilder::PixelColorTolerance ( )

Returns the transparency pixel color tolerance.

The range of this value is 0 to 255.

Created in NX9.0.0.

License requirements : None

NXOpen::Display::ImageBaseBuilder::ReferenceDirection NXOpen::Display::ImageBaseBuilder::ReferenceDirectionOption ( )

Returns the image alignment reference direction type.

   @link Display::ImageBaseBuilder::ReferenceDirectionHorizontal Display::ImageBaseBuilder::ReferenceDirectionHorizontal@endlink 
   means rotate the image to align its horizontal direction with the user-specified 
   reference direction (if defined).

Created in NX9.0.0.

License requirements : None

void NXOpen::Display::ImageBaseBuilder::ResetImageSize ( )

Resets the image to its original size.

Created in NX9.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Display::ImageBaseBuilder::RotateAngleOfReferenceVector ( )

Returns the current rotation angle of image from aligned reference direction
Created in NX9.0.0.

License requirements : None

void NXOpen::Display::ImageBaseBuilder::RotateLeft ( )

Rotates the image 90 degrees counter-clockwise.

Created in NX9.0.0.

License requirements : None

void NXOpen::Display::ImageBaseBuilder::RotateRight ( )

Rotates the image 90 degrees clockwise.

Created in NX9.0.0.

License requirements : None

void NXOpen::Display::ImageBaseBuilder::SetBackgroundColor ( const std::vector< double > & backgroundColor )

Sets the background color (RGB value) of the image; only valid when Display::ImageBaseBuilder::ColorMode and Display::ImageBaseBuilder::SetColorMode is set to Display::ImageBaseBuilder::ImageColorModesGreyscale .

   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

void NXOpen::Display::ImageBaseBuilder::SetBasePointChoice ( NXOpen::Display::ImageBaseBuilder::BasePointChoices basePoint )

Sets the image reference base point choice.

If you choose Display::ImageBaseBuilder::BasePointChoicesUserDefined , use Display::ImageBaseBuilder::SetUserBasePoint to set a point as the User-Defined point.

Created in NX9.0.0.

License requirements : None

Parameters

basePoint basepoint

void NXOpen::Display::ImageBaseBuilder::SetColorMode ( NXOpen::Display::ImageBaseBuilder::ImageColorModes colorMode )

Sets the color mode to display the image.

Created in NX9.0.0.

License requirements : None

Parameters

colorMode colormode

void NXOpen::Display::ImageBaseBuilder::SetCornerPoints	(	const NXOpen::Point3d &	point1,
		const NXOpen::Point3d &	point2,
		const NXOpen::Point3d &	point3,
		const NXOpen::Point3d &	point4
	)

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

void NXOpen::Display::ImageBaseBuilder::SetForegroundColor ( const std::vector< double > & foregroundColor )

Sets the foreground color (RGB value) of the image; only valid when Display::ImageBaseBuilder::ColorMode and Display::ImageBaseBuilder::SetColorMode is set to Display::ImageBaseBuilder::ImageColorModesGreyscale .

   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

void NXOpen::Display::ImageBaseBuilder::SetImageFile ( const NXString & filename )

Sets the image file
Created in NX9.0.0.

License requirements : None

Parameters

filename filename

void NXOpen::Display::ImageBaseBuilder::SetImageFile ( const char * filename )

Sets the image file
Created in NX9.0.0.

License requirements : None

Parameters

filename filename

void NXOpen::Display::ImageBaseBuilder::SetImageFromPart ( const NXString & imageName )

Set a 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 Display::ImageData object

void NXOpen::Display::ImageBaseBuilder::SetImageFromPart ( const char * imageName )

Set a 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 Display::ImageData object

void NXOpen::Display::ImageBaseBuilder::SetImageReferencePoint1 ( NXOpen::Point * imageReferencePoint1 )

Sets the image reference point1; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

   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 : None

Parameters

imageReferencePoint1 imagereferencepoint1

void NXOpen::Display::ImageBaseBuilder::SetImageReferencePoint2 ( NXOpen::Point * imageReferencePoint2 )

Sets the image reference point2; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

   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 : None

Parameters

imageReferencePoint2 imagereferencepoint2

void NXOpen::Display::ImageBaseBuilder::SetImageReferencePoint3 ( NXOpen::Point * imageReferencePoint3 )

Sets the image reference point3; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling and Display::ImageBaseBuilder::LockAspectRatio and Display::ImageBaseBuilder::SetLockAspectRatio is set to 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 : None

Parameters

imageReferencePoint3 imagereferencepoint3

void NXOpen::Display::ImageBaseBuilder::SetInsertionPointOption ( NXOpen::Display::ImageBaseBuilder::InsertionPoint insertPoint )

Sets the image insertion point type
Created in NX9.0.0.

License requirements : None

Parameters

insertPoint insertpoint

void NXOpen::Display::ImageBaseBuilder::SetLockAspectRatio ( bool lockAspectRatio )

Sets the lock aspect ratio
Created in NX9.0.0.

License requirements : None

Parameters

lockAspectRatio lockaspectratio

void NXOpen::Display::ImageBaseBuilder::SetModelReferencePoint1 ( NXOpen::Point * modelReferencePoint1 )

Sets the model reference point1; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

   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 : None

Parameters

modelReferencePoint1 modelreferencepoint1

void NXOpen::Display::ImageBaseBuilder::SetModelReferencePoint2 ( NXOpen::Point * modelReferencePoint2 )

Sets the model reference point2; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling .

   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 : None

Parameters

modelReferencePoint2 modelreferencepoint2

void NXOpen::Display::ImageBaseBuilder::SetModelReferencePoint3 ( NXOpen::Point * modelReferencePoint3 )

Sets the model reference point3; only valid when Display::ImageBaseBuilder::SizeOption and Display::ImageBaseBuilder::SetSizeOption is set to Display::ImageBaseBuilder::SizeOptionsReferenceScaling and Display::ImageBaseBuilder::LockAspectRatio and Display::ImageBaseBuilder::SetLockAspectRatio is set to 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 : None

Parameters

modelReferencePoint3 modelreferencepoint3

void NXOpen::Display::ImageBaseBuilder::SetOverallTranslucency ( int overallTranslucency )

Sets the overall translucency.

The range of this value is 0 to 100.
Created in NX9.0.0.

License requirements : None

Parameters

overallTranslucency overalltranslucency

void NXOpen::Display::ImageBaseBuilder::SetPixelColorTolerance ( int colorTolerence )

Sets the transparency pixel color tolerance.

The range of this value is 0 to 255.

Created in NX9.0.0.

License requirements : None

Parameters

colorTolerence colortolerence

void NXOpen::Display::ImageBaseBuilder::SetReferenceDirectionOption ( NXOpen::Display::ImageBaseBuilder::ReferenceDirection referenceDirection )

Sets the image alignment reference direction type.

   @link Display::ImageBaseBuilder::ReferenceDirectionHorizontal Display::ImageBaseBuilder::ReferenceDirectionHorizontal@endlink 
   means rotate the image to align its horizontal direction with the user-specified 
   reference direction (if defined).

Created in NX9.0.0.

License requirements : None

Parameters

referenceDirection referencedirection

void NXOpen::Display::ImageBaseBuilder::SetSizeOption ( NXOpen::Display::ImageBaseBuilder::SizeOptions sizeOption )

Sets the size option
Created in NX9.0.0.

License requirements : None

Parameters

sizeOption sizeoption

void NXOpen::Display::ImageBaseBuilder::SetTransparencyColorOption ( NXOpen::Display::ImageBaseBuilder::TransparencyColorFrom transparencyColorOption )

Sets the transparency color option
Created in NX9.0.0.

License requirements : None

Parameters

transparencyColorOption transparencycoloroption

void NXOpen::Display::ImageBaseBuilder::SetTransparentPixelColor ( const std::vector< double > & transparencyColor )

Sets the transparency color (RGB value) of the image; only valid when Display::ImageBaseBuilder::TransparencyColorOption and Display::ImageBaseBuilder::SetTransparencyColorOption is set to Display::ImageBaseBuilder::TransparencyColorFromPixelColor .

   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

void NXOpen::Display::ImageBaseBuilder::SetUserBasePoint ( NXOpen::Point * basePoint )

Sets the user defined base point.

This is valid when you set Display::ImageBaseBuilder::BasePointChoice and Display::ImageBaseBuilder::SetBasePointChoice to Display::ImageBaseBuilder::BasePointChoicesUserDefined

Created in NX9.0.0.

License requirements : None

Parameters

basePoint basepoint

void NXOpen::Display::ImageBaseBuilder::SetUserInsertionPoint ( NXOpen::Point * insertPoint )

Sets the user defined insertion point
Created in NX9.0.0.

License requirements : None

Parameters

insertPoint insertpoint

void NXOpen::Display::ImageBaseBuilder::SetUserReferenceDirection ( NXOpen::Direction * userDirection )

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 : None

Parameters

userDirection userdirection

NXOpen::Display::ImageBaseBuilder::SizeOptions NXOpen::Display::ImageBaseBuilder::SizeOption ( )

Returns the size option
Created in NX9.0.0.

License requirements : None

NXOpen::Display::ImageBaseBuilder::TransparencyColorFrom NXOpen::Display::ImageBaseBuilder::TransparencyColorOption ( )

Returns the transparency color option
Created in NX9.0.0.

License requirements : None

NXOpen::Point* NXOpen::Display::ImageBaseBuilder::UserBasePoint ( )

Returns the user defined base point.

This is valid when you set Display::ImageBaseBuilder::BasePointChoice and Display::ImageBaseBuilder::SetBasePointChoice to Display::ImageBaseBuilder::BasePointChoicesUserDefined

Created in NX9.0.0.

License requirements : None

NXOpen::Point* NXOpen::Display::ImageBaseBuilder::UserInsertionPoint ( )

Returns the user defined insertion point
Created in NX9.0.0.

License requirements : None

NXOpen::Direction* NXOpen::Display::ImageBaseBuilder::UserReferenceDirection ( )

Returns the user defined reference direction vector.

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

Created in NX9.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Display::ImageBaseBuilder::Width ( )

Returns the width of the image as an expression.

Created in NX9.0.0.

License requirements : None

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

Display_ImageBaseBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation