Supports debug dialog UGS::DebugUI::UICompImageTest which is used to test Gateway::ImageIO, DSS, CGP, AW2D, and CGM image functionality. More...

Inheritance diagram for NXOpen::Display::ImageTestBuilder:

Public Types
enum	AttributeType { AttributeTypeNone, AttributeTypeDeEmphasis, AttributeTypeShowThrough, AttributeTypeOverlay }
	Indicates the extra display attribute that is enabled for the display object (DISP_OBJ) that displays the image in the graphics window. More...

enum	FormatType { FormatTypeOriginal, FormatTypeRgb, FormatTypeRgba, FormatTypeGrayscale, FormatTypeGrayscaleAlpha, FormatTypeBitonal, FormatTypeAlpha }
	Indicates the Format used to display the image. More...

enum	OriginLocationType { OriginLocationTypeTopLeft, OriginLocationTypeTopCenter, OriginLocationTypeTopRight, OriginLocationTypeMiddleLeft, OriginLocationTypeMiddleCenter, OriginLocationTypeMiddleRight, OriginLocationTypeBottomLeft, OriginLocationTypeBottomCenter, OriginLocationTypeBottomRight }
	Indicates the location on the image that represents its origin. More...

Public Member Functions
bool	DeletePreviousImages ()
	Returns the Delete Previous Images setting. More...

NXOpen::Display::ImageTestBuilder::FormatType	DisplayFormat ()
	Returns the Format used to display the image. More...

bool	DrawBorder ()
	Returns the DrawBorder setting. More...

NXOpen::Display::ImageTestBuilder::AttributeType	ExtraAttribute ()
	Returns the extra display attribute that is enabled for the display object (DISP_OBJ) that displays the image in the graphics window. More...

std::vector< double >	GetBackgroundColor ()
	Returns the BackgroundColor. More...

std::vector< double >	GetForegroundColor ()
	Returns the ForegroundColor. More...

std::vector< double >	GetTransparencyPixel ()
	Returns the TransparencyPixel. More...

NXString	ImageDetails ()
	Returns the image details Created in NX9.0.0. More...

NXString	ImageFile ()
	Returns the path of the image file. More...

NXString	MatrixVectors ()
	Returns the matrix vectors Created in NX9.0.0. More...

NXOpen::Display::ImageTestBuilder::OriginLocationType	OriginLocation ()
	Returns the location on the image that represents its origin. More...

NXOpen::Display::ImageTestBuilder::FormatType	PixelFormat ()
	Returns the Format of the image. More...

int	PixelsPerInch ()
	Returns the Pixels Per Inch setting. More...

void	SetBackgroundColor (const std::vector< double > &backgroundColor)
	Sets the BackgroundColor. More...

void	SetDeletePreviousImages (bool deletePreviousImages)
	Sets the Delete Previous Images setting. More...

void	SetDisplayFormat (NXOpen::Display::ImageTestBuilder::FormatType displayFormat)
	Sets the Format used to display the image. More...

void	SetDrawBorder (bool drawBorder)
	Sets the DrawBorder setting. More...

void	SetExtraAttribute (NXOpen::Display::ImageTestBuilder::AttributeType extraAttribute)
	Sets the extra display attribute that is enabled for the display object (DISP_OBJ) that displays the image in the graphics window. More...

void	SetForegroundColor (const std::vector< double > &foregroundColor)
	Sets the ForegroundColor. More...

void	SetImageDetails (const NXString &imageDetails)
	Sets the image details Created in NX9.0.0. More...

void	SetImageDetails (const char *imageDetails)
	Sets the image details Created in NX9.0.0. More...

void	SetImageFile (const NXString &filename)
	Sets the path of the image file. More...

void	SetImageFile (const char *filename)
	Sets the path of the image file. More...

void	SetMatrixVectors (const NXString &matrixVectors)
	Sets the matrix vectors Created in NX9.0.0. More...

void	SetMatrixVectors (const char *matrixVectors)
	Sets the matrix vectors Created in NX9.0.0. More...

void	SetOriginLocation (NXOpen::Display::ImageTestBuilder::OriginLocationType originLocation)
	Sets the location on the image that represents its origin. More...

void	SetPixelFormat (NXOpen::Display::ImageTestBuilder::FormatType pixelFormat)
	Sets the Format of the image. More...

void	SetPixelsPerInch (int pixelsPerInch)
	Sets the Pixels Per Inch setting. More...

void	SetSubimageRectangleHeight (int subimageRectangleHeight)
	Sets the height of the SubimageRectangle. More...

void	SetSubimageRectangleWidth (int subimageRectangleWidth)
	Sets the width of the SubimageRectangle. More...

void	SetSubimageRectangleX (int subimageRectangleX)
	Sets the X coordinate of the upper-left corner of the SubimageRectangle. More...

void	SetSubimageRectangleY (int subimageRectangleY)
	Sets the Y coordinate of the upper-left corner of the SubimageRectangle. More...

void	SetSuppressDeEmphasis (bool suppressDeEmphasis)
	Sets the SuppressDeEmphasis setting. More...

void	SetSuppressSmoothing (bool suppressSmoothing)
	Sets the SuppressSmoothing setting. More...

void	SetTranslucency (int translucency)
	Sets the Translucency setting. More...

void	SetTransparencyPixel (const std::vector< double > &transparencyPixel)
	Sets the TransparencyPixel. More...

void	SetUseTransparencyPixel (bool useTransparencyPixel)
	Sets the UseTransparencyPixel setting. More...

int	SubimageRectangleHeight ()
	Returns the height of the SubimageRectangle. More...

int	SubimageRectangleWidth ()
	Returns the width of the SubimageRectangle. More...

int	SubimageRectangleX ()
	Returns the X coordinate of the upper-left corner of the SubimageRectangle. More...

int	SubimageRectangleY ()
	Returns the Y coordinate of the upper-left corner of the SubimageRectangle. More...

bool	SuppressDeEmphasis ()
	Returns the SuppressDeEmphasis setting. More...

bool	SuppressSmoothing ()
	Returns the SuppressSmoothing setting. More...

int	Translucency ()
	Returns the Translucency setting. More...

bool	UseTransparencyPixel ()
	Returns the UseTransparencyPixel setting. More...

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

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

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

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

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Supports debug dialog UGS::DebugUI::UICompImageTest which is used to test Gateway::ImageIO, DSS, CGP, AW2D, and CGM image functionality.

To create a new instance of this class, use NXOpen::DebugSession::CreateImageTestBuilder

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Display::ImageTestBuilder::AttributeType

Indicates the extra display attribute that is enabled for the display object (DISP_OBJ) that displays the image in the graphics window.

Enumerator
AttributeTypeNone	none
AttributeTypeDeEmphasis	de emphasis
AttributeTypeShowThrough	show through
AttributeTypeOverlay	overlay

enum NXOpen::Display::ImageTestBuilder::FormatType

Indicates the Format used to display the image.

Enumerator
FormatTypeOriginal	original
FormatTypeRgb	rgb
FormatTypeRgba	rgba
FormatTypeGrayscale	grayscale
FormatTypeGrayscaleAlpha	grayscale alpha
FormatTypeBitonal	bitonal
FormatTypeAlpha	alpha

enum NXOpen::Display::ImageTestBuilder::OriginLocationType

Indicates the location on the image that represents its origin.

Enumerator
OriginLocationTypeTopLeft	top left
OriginLocationTypeTopCenter	top center
OriginLocationTypeTopRight	top right
OriginLocationTypeMiddleLeft	middle left
OriginLocationTypeMiddleCenter	middle center
OriginLocationTypeMiddleRight	middle right
OriginLocationTypeBottomLeft	bottom left
OriginLocationTypeBottomCenter	bottom center
OriginLocationTypeBottomRight	bottom right

Member Function Documentation

bool NXOpen::Display::ImageTestBuilder::DeletePreviousImages ( )

Returns the Delete Previous Images setting.

Created in NX9.0.0.

License requirements : None

NXOpen::Display::ImageTestBuilder::FormatType NXOpen::Display::ImageTestBuilder::DisplayFormat ( )

Returns the Format used to display the image.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Display::ImageTestBuilder::DrawBorder ( )

Returns the DrawBorder setting.

Created in NX9.0.0.

License requirements : None

NXOpen::Display::ImageTestBuilder::AttributeType NXOpen::Display::ImageTestBuilder::ExtraAttribute ( )

Returns the extra display attribute that is enabled for the display object (DISP_OBJ) that displays the image in the graphics window.

Created in NX9.0.0.

License requirements : None

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

Returns the BackgroundColor.

Returns: Array of 3 RGB values, each between 0 and 1
Created in NX9.0.0.

License requirements : None

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

Returns the ForegroundColor.

Returns: Array of 3 RGB values, each between 0 and 1
Created in NX9.0.0.

License requirements : None

std::vector<double> NXOpen::Display::ImageTestBuilder::GetTransparencyPixel ( )

Returns the TransparencyPixel.

Returns: Array of 3 RGB values, each between 0 and 1
Created in NX9.0.0.

License requirements : None

NXString NXOpen::Display::ImageTestBuilder::ImageDetails ( )

Returns the image details
Created in NX9.0.0.

License requirements : None

NXString NXOpen::Display::ImageTestBuilder::ImageFile ( )

Returns the path of the image file.

Created in NX9.0.0.

License requirements : None

NXString NXOpen::Display::ImageTestBuilder::MatrixVectors ( )

Returns the matrix vectors
Created in NX9.0.0.

License requirements : None

NXOpen::Display::ImageTestBuilder::OriginLocationType NXOpen::Display::ImageTestBuilder::OriginLocation ( )

Returns the location on the image that represents its origin.

Created in NX9.0.0.

License requirements : None

NXOpen::Display::ImageTestBuilder::FormatType NXOpen::Display::ImageTestBuilder::PixelFormat ( )

Returns the Format of the image.

Created in NX9.0.0.

License requirements : None

int NXOpen::Display::ImageTestBuilder::PixelsPerInch ( )

Returns the Pixels Per Inch setting.

Created in NX9.0.0.

License requirements : None

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

Sets the BackgroundColor.

Created in NX9.0.0.

License requirements : None

Parameters

backgroundColor Array of 3 RGB values, each between 0 and 1

void NXOpen::Display::ImageTestBuilder::SetDeletePreviousImages ( bool deletePreviousImages )

Sets the Delete Previous Images setting.

Created in NX9.0.0.

License requirements : None

Parameters

deletePreviousImages deletepreviousimages

void NXOpen::Display::ImageTestBuilder::SetDisplayFormat ( NXOpen::Display::ImageTestBuilder::FormatType displayFormat )

Sets the Format used to display the image.

Created in NX9.0.0.

License requirements : None

Parameters

displayFormat displayformat

void NXOpen::Display::ImageTestBuilder::SetDrawBorder ( bool drawBorder )

Sets the DrawBorder setting.

Created in NX9.0.0.

License requirements : None

Parameters

drawBorder drawborder

void NXOpen::Display::ImageTestBuilder::SetExtraAttribute ( NXOpen::Display::ImageTestBuilder::AttributeType extraAttribute )

Sets the extra display attribute that is enabled for the display object (DISP_OBJ) that displays the image in the graphics window.

Created in NX9.0.0.

License requirements : None

Parameters

extraAttribute extraattribute

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

Sets the ForegroundColor.

Created in NX9.0.0.

License requirements : None

Parameters

foregroundColor Array of 3 RGB values, each between 0 and 1

void NXOpen::Display::ImageTestBuilder::SetImageDetails ( const NXString & imageDetails )

Sets the image details
Created in NX9.0.0.

License requirements : None

Parameters

imageDetails imagedetails

void NXOpen::Display::ImageTestBuilder::SetImageDetails ( const char * imageDetails )

Sets the image details
Created in NX9.0.0.

License requirements : None

Parameters

imageDetails imagedetails

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

Sets the path of the image file.

Created in NX9.0.0.

License requirements : None

Parameters

filename filename

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

Sets the path of the image file.

Created in NX9.0.0.

License requirements : None

Parameters

filename filename

void NXOpen::Display::ImageTestBuilder::SetMatrixVectors ( const NXString & matrixVectors )

Sets the matrix vectors
Created in NX9.0.0.

License requirements : None

Parameters

matrixVectors matrixvectors

void NXOpen::Display::ImageTestBuilder::SetMatrixVectors ( const char * matrixVectors )

Sets the matrix vectors
Created in NX9.0.0.

License requirements : None

Parameters

matrixVectors matrixvectors

void NXOpen::Display::ImageTestBuilder::SetOriginLocation ( NXOpen::Display::ImageTestBuilder::OriginLocationType originLocation )

Sets the location on the image that represents its origin.

Created in NX9.0.0.

License requirements : None

Parameters

originLocation originlocation

void NXOpen::Display::ImageTestBuilder::SetPixelFormat ( NXOpen::Display::ImageTestBuilder::FormatType pixelFormat )

Sets the Format of the image.

Created in NX9.0.0.

License requirements : None

Parameters

pixelFormat pixelformat

void NXOpen::Display::ImageTestBuilder::SetPixelsPerInch ( int pixelsPerInch )

Sets the Pixels Per Inch setting.

Created in NX9.0.0.

License requirements : None

Parameters

pixelsPerInch pixelsperinch

void NXOpen::Display::ImageTestBuilder::SetSubimageRectangleHeight ( int subimageRectangleHeight )

Sets the height of the SubimageRectangle.

Created in NX9.0.0.

License requirements : None

Parameters

subimageRectangleHeight subimagerectangleheight

void NXOpen::Display::ImageTestBuilder::SetSubimageRectangleWidth ( int subimageRectangleWidth )

Sets the width of the SubimageRectangle.

Created in NX9.0.0.

License requirements : None

Parameters

subimageRectangleWidth subimagerectanglewidth

void NXOpen::Display::ImageTestBuilder::SetSubimageRectangleX ( int subimageRectangleX )

Sets the X coordinate of the upper-left corner of the SubimageRectangle.

Created in NX9.0.0.

License requirements : None

Parameters

subimageRectangleX subimagerectanglex

void NXOpen::Display::ImageTestBuilder::SetSubimageRectangleY ( int subimageRectangleY )

Sets the Y coordinate of the upper-left corner of the SubimageRectangle.

Created in NX9.0.0.

License requirements : None

Parameters

subimageRectangleY subimagerectangley

void NXOpen::Display::ImageTestBuilder::SetSuppressDeEmphasis ( bool suppressDeEmphasis )

Sets the SuppressDeEmphasis setting.

Created in NX9.0.0.

License requirements : None

Parameters

suppressDeEmphasis suppressdeemphasis

void NXOpen::Display::ImageTestBuilder::SetSuppressSmoothing ( bool suppressSmoothing )

Sets the SuppressSmoothing setting.

Created in NX9.0.0.

License requirements : None

Parameters

suppressSmoothing suppresssmoothing

void NXOpen::Display::ImageTestBuilder::SetTranslucency ( int translucency )

Sets the Translucency setting.

Created in NX9.0.0.

License requirements : None

Parameters

translucency translucency

void NXOpen::Display::ImageTestBuilder::SetTransparencyPixel ( const std::vector< double > & transparencyPixel )

Sets the TransparencyPixel.

Created in NX9.0.0.

License requirements : None

Parameters

transparencyPixel Array of 3 RGB values, each between 0 and 1

void NXOpen::Display::ImageTestBuilder::SetUseTransparencyPixel ( bool useTransparencyPixel )

Sets the UseTransparencyPixel setting.

Created in NX9.0.0.

License requirements : None

Parameters

useTransparencyPixel usetransparencypixel

int NXOpen::Display::ImageTestBuilder::SubimageRectangleHeight ( )

Returns the height of the SubimageRectangle.

Created in NX9.0.0.

License requirements : None

int NXOpen::Display::ImageTestBuilder::SubimageRectangleWidth ( )

Returns the width of the SubimageRectangle.

Created in NX9.0.0.

License requirements : None

int NXOpen::Display::ImageTestBuilder::SubimageRectangleX ( )

Returns the X coordinate of the upper-left corner of the SubimageRectangle.

Created in NX9.0.0.

License requirements : None

int NXOpen::Display::ImageTestBuilder::SubimageRectangleY ( )

Returns the Y coordinate of the upper-left corner of the SubimageRectangle.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Display::ImageTestBuilder::SuppressDeEmphasis ( )

Returns the SuppressDeEmphasis setting.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Display::ImageTestBuilder::SuppressSmoothing ( )

Returns the SuppressSmoothing setting.

Created in NX9.0.0.

License requirements : None

int NXOpen::Display::ImageTestBuilder::Translucency ( )

Returns the Translucency setting.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Display::ImageTestBuilder::UseTransparencyPixel ( )

Returns the UseTransparencyPixel setting.

Created in NX9.0.0.

License requirements : None

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

Display_ImageTestBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation