Represents a Display::RasterImageBuilder . More...

Inheritance diagram for NXOpen::Display::RasterImageBuilder:

Public Member Functions
void	SetTarget (NXOpen::Plane *targetObject)
	Sets the plane the raster image is placed onto Created in NX9.0.0.

NXOpen::Plane *	Target ()
	Returns the plane the raster image is placed onto Created in NX9.0.0.

Public Member Functions inherited from NXOpen::Display::ImageBaseBuilder
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.

Additional Inherited Members
Public Types inherited from NXOpen::Display::ImageBaseBuilder
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...

Detailed Description

Represents a Display::RasterImageBuilder .

@link Display::RasterImage Display::RasterImage@endlink  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. 
 <br> To create a new instance of this class, use @link Display::ImageCollection::CreateRasterImageBuilder  Display::ImageCollection::CreateRasterImageBuilder @endlink  <br>

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.

Member Function Documentation

void NXOpen::Display::RasterImageBuilder::SetTarget ( NXOpen::Plane * targetObject )

Sets the plane the raster image is placed onto
Created in NX9.0.0.

License requirements : None

Parameters

targetObject targetobject

NXOpen::Plane* NXOpen::Display::RasterImageBuilder::Target ( )

Returns the plane the raster image is placed onto
Created in NX9.0.0.

License requirements : None

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

Display_RasterImageBuilder.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation