NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
List of all members
NXOpen::TDP::TemplateImageBuilder Class Reference

Represents a Template Image Builder
To create a new instance of this class, use NXOpen::TDP::Manager::CreateTemplateImageBuilder

Created in NX1847.0.0. More...

Inheritance diagram for NXOpen::TDP::TemplateImageBuilder:
NXOpen::Display::ImageBaseBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

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...
 
- Public Member Functions inherited from NXOpen::Display::ImageBaseBuilder
void AlignImageToReferenceDirection ()
 Align Image to Reference Direction
Created in NX9.0.0. More...
 
NXOpen::Display::ImageBaseBuilder::BasePointChoices BasePointChoice ()
 Returns the image reference base point choice. More...
 
NXOpen::Display::ImageBaseBuilder::ImageColorModes ColorMode ()
 Returns the color mode to display the image. More...
 
void FlipHorizontal ()
 Flips the image horizontally. More...
 
void FlipVertical ()
 Flips the image vertically. More...
 
std::vector< double > GetBackgroundColor ()
 Gets the background color (RGB value) of the image. More...
 
void GetCornerPoints (NXOpen::Point3d *point1, NXOpen::Point3d *point2, NXOpen::Point3d *point3, NXOpen::Point3d *point4)
 Get the image corner points. More...
 
std::vector< double > GetForegroundColor ()
 Gets the foreground color (RGB value) of the image. More...
 
std::vector< NXStringGetImagesInPart ()
 Provide a list of names of the NXOpen::Display::ImageData objects saved in current part file. More...
 
std::vector< double > GetTransparentPixelColor ()
 Gets the transparency color (RGB value) of the image. More...
 
NXOpen::ExpressionHeight ()
 Returns. More...
 
NXString ImageFile ()
 Returns the image file
Created in NX9.0.0. More...
 
NXOpen::PointImageReferencePoint1 ()
 Returns. More...
 
NXOpen::PointImageReferencePoint2 ()
 Returns. More...
 
NXOpen::PointImageReferencePoint3 ()
 Returns. More...
 
NXOpen::Point3d InsertionPointLocation ()
 Returns the insertion point of the image
Created in NX1847.0.0. More...
 
NXOpen::Display::ImageBaseBuilder::InsertionPoint InsertionPointOption ()
 Returns the image insertion point type
Created in NX9.0.0. More...
 
bool LockAspectRatio ()
 Returns the lock aspect ratio
Created in NX9.0.0. More...
 
NXOpen::PointModelReferencePoint1 ()
 Returns. More...
 
NXOpen::PointModelReferencePoint2 ()
 Returns. More...
 
NXOpen::PointModelReferencePoint3 ()
 Returns. More...
 
void OrientViewToImage ()
 Orients and fits the work view's view direction along the reverse normal direction of the image
Created in NX9.0.0. More...
 
int OverallTranslucency ()
 Returns the overall translucency. More...
 
int PixelColorTolerance ()
 Returns the transparency pixel color tolerance. More...
 
NXOpen::Display::ImageBaseBuilder::ReferenceDirection ReferenceDirectionOption ()
 Returns the image alignment reference direction type. More...
 
void ResetImageSize ()
 Resets the image to its original size. More...
 
NXOpen::ExpressionRotateAngleOfReferenceVector ()
 Returns the current rotation angle of image from aligned reference direction
Created in NX9.0.0. More...
 
void RotateLeft ()
 Rotates the image 90 degrees counter-clockwise. More...
 
void RotateRight ()
 Rotates the image 90 degrees clockwise. More...
 
void SetBackgroundColor (const std::vector< double > &backgroundColor)
 Sets the background color (RGB value) of the image. More...
 
void SetBasePointChoice (NXOpen::Display::ImageBaseBuilder::BasePointChoices basePoint)
 Sets the image reference base point choice. More...
 
void SetColorMode (NXOpen::Display::ImageBaseBuilder::ImageColorModes colorMode)
 Sets the color mode to display the image. More...
 
void SetCornerPoints (const NXOpen::Point3d &point1, const NXOpen::Point3d &point2, const NXOpen::Point3d &point3, const NXOpen::Point3d &point4)
 Set the image corner points. More...
 
void SetForegroundColor (const std::vector< double > &foregroundColor)
 Sets the foreground color (RGB value) of the image. More...
 
void SetImageFile (const NXString &filename)
 Sets the image file
Created in NX9.0.0. More...
 
void SetImageFile (const char *filename)
 Sets the image file
Created in NX9.0.0. More...
 
void SetImageFromPart (const NXString &imageName)
 Set a NXOpen::Display::ImageData object currently stored in the part as the image used by the builder. More...
 
void SetImageFromPart (const char *imageName)
 Set a NXOpen::Display::ImageData object currently stored in the part as the image used by the builder. More...
 
void SetImageReferencePoint1 (NXOpen::Point *imageReferencePoint1)
 Sets. More...
 
void SetImageReferencePoint2 (NXOpen::Point *imageReferencePoint2)
 Sets. More...
 
void SetImageReferencePoint3 (NXOpen::Point *imageReferencePoint3)
 Sets. More...
 
void SetInsertionPointLocation (const NXOpen::Point3d &insertPoint)
 Sets the insertion point of the image
Created in NX1847.0.0. More...
 
void SetInsertionPointOption (NXOpen::Display::ImageBaseBuilder::InsertionPoint insertPoint)
 Sets the image insertion point type
Created in NX9.0.0. More...
 
void SetLockAspectRatio (bool lockAspectRatio)
 Sets the lock aspect ratio
Created in NX9.0.0. More...
 
void SetModelReferencePoint1 (NXOpen::Point *modelReferencePoint1)
 Sets. More...
 
void SetModelReferencePoint2 (NXOpen::Point *modelReferencePoint2)
 Sets. More...
 
void SetModelReferencePoint3 (NXOpen::Point *modelReferencePoint3)
 Sets. More...
 
void SetOverallTranslucency (int overallTranslucency)
 Sets the overall translucency. More...
 
void SetPixelColorTolerance (int colorTolerence)
 Sets the transparency pixel color tolerance. More...
 
void SetReferenceDirectionOption (NXOpen::Display::ImageBaseBuilder::ReferenceDirection referenceDirection)
 Sets the image alignment reference direction type. More...
 
void SetSizeOption (NXOpen::Display::ImageBaseBuilder::SizeOptions sizeOption)
 Sets the size option
Created in NX9.0.0. More...
 
void SetTransparencyColorOption (NXOpen::Display::ImageBaseBuilder::TransparencyColorFrom transparencyColorOption)
 Sets the transparency color option
Created in NX9.0.0. More...
 
void SetTransparentPixelColor (const std::vector< double > &transparencyColor)
 Sets the transparency color (RGB value) of the image. More...
 
void SetUserBasePoint (NXOpen::Point *basePoint)
 Sets. More...
 
void SetUserInsertionPoint (NXOpen::Point *insertPoint)
 Sets the user defined insertion point
Created in NX9.0.0. More...
 
void SetUserReferenceDirection (NXOpen::Direction *userDirection)
 Sets the user defined reference direction vector. More...
 
NXOpen::Display::ImageBaseBuilder::SizeOptions SizeOption ()
 Returns the size option
Created in NX9.0.0. More...
 
NXOpen::Display::ImageBaseBuilder::TransparencyColorFrom TransparencyColorOption ()
 Returns the transparency color option
Created in NX9.0.0. More...
 
NXOpen::PointUserBasePoint ()
 Returns. More...
 
NXOpen::PointUserInsertionPoint ()
 Returns the user defined insertion point
Created in NX9.0.0. More...
 
NXOpen::DirectionUserReferenceDirection ()
 Returns the user defined reference direction vector. More...
 
NXOpen::ExpressionWidth ()
 Returns. More...
 

Detailed Description

Represents a Template Image Builder
To create a new instance of this class, use NXOpen::TDP::Manager::CreateTemplateImageBuilder

Created in NX1847.0.0.



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