Represents a NXOpen::Display::DecalBuilder
This class is restricted to being called from a program running during an Interactive NX session. More...

Inheritance diagram for NXOpen::Display::DecalBuilder:

Public Types
enum	Anchor { AnchorTopLeft, AnchorCenter, AnchorBottomLeft, AnchorTopMiddle, AnchorTopRight, AnchorLeftMiddle, AnchorRightMiddle, AnchorBottomMiddle, AnchorBottomRight }
	image anchor More...

enum	DecalIllumination { DecalIlluminationUseUnderlyingMaterial, DecalIlluminationUseDecalMaterial }
	decal illumination type More...

enum	DecalReflectivities { DecalReflectivitiesUseMatte, DecalReflectivitiesUsePlastic, DecalReflectivitiesUseMirror, DecalReflectivitiesUseMetal, DecalReflectivitiesUseGlass }
	decal reflectivity type More...

enum	ImageSize { ImageSizeTrueSize, ImageSizeOneTwentyEight, ImageSizeTwoFiftySix, ImageSizeFiveTwelve, ImageSizeOneOTwoFour, ImageSizeTwoOFourEight, ImageSizeFourONineSix }
	image size type More...

enum	Scaling { ScalingToFace, ScalingToImageSize, ScalingToUniformScale, ScalingToNonUniformScale }
	decal scaling type More...

Public Member Functions
NXOpen::Display::DecalBuilder::Anchor	AnchorType ()
	Returns the anchor type Created in NX6.0.0. More...

double	AspectRatio ()
	Returns the decal image aspect ratio Created in NX6.0.0. More...

NXString	DecalName ()
	Returns the decal name Created in NX6.0.0. More...

double	DecalReflectivity ()
	Returns the decal reflectivity Created in NX6.0.0. More...

bool	EnableEngraving ()
	Returns the engraving enable toggle Created in NX6.0.0. More...

double	EngravingAmplitude ()
	Returns the decal engraving amplitude Created in NX6.0.0. More...

double	EngravingSoftness ()
	Returns the engraving softness Created in NX6.0.0. More...

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

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

std::vector< double >	GetTransparencyColor ()
	Returns the transparency color. More...

double	HeightScale ()
	Returns the decal height scale Created in NX6.0.0. More...

NXOpen::Display::DecalBuilder::DecalIllumination	IlluminationType ()
	Returns the illumination type Created in NX6.0.0. More...

NXOpen::Display::Image *	Image ()
	Returns the image builder Created in NX6.0.0. More...

NXString	ImageFilename ()
	Returns the decal image file name Created in NX6.0.0. More...

NXOpen::Display::DecalBuilder::ImageSize	ImageSizeType ()
	Returns the image size type Created in NX6.0.0. More...

NXOpen::Direction *	NormalVector ()
	Returns the decal normal vector Created in NX6.0.0. More...

NXOpen::Vector3d	NormalVectorValue ()
	Returns the decal normal vector value Created in NX6.0.0. More...

NXOpen::SelectNXObjectList *	Object ()
	Returns the object(face, body and facetted body) to apply the decal to Created in NX6.0.0. More...

NXOpen::Point *	Origin ()
	Returns the origin Created in NX6.0.0. More...

NXOpen::Point3d	OriginPosition ()
	Returns the origin_pos Created in NX6.0.0. More...

bool	OverwriteExistingFile ()
	Returns the overwrite existing file option - true to overwrite and return no error, false to return error Created in NX10.0.3. More...

NXOpen::Display::DecalBuilder::DecalReflectivities	ReflectivityType ()
	Returns the reflectivity type Created in NX10.0.2. More...

double	Rotation ()
	Returns the decal rotation Created in NX6.0.0. More...

double	Scale ()
	Returns the decal scale Created in NX6.0.0. More...

NXOpen::Display::DecalBuilder::Scaling	ScalingType ()
	Returns the scaling type Created in NX6.0.0. More...

void	SetAnchorType (NXOpen::Display::DecalBuilder::Anchor anchorType)
	Sets the anchor type Created in NX6.0.0. More...

void	SetAspectRatio (double aspectRatio)
	Sets the decal image aspect ratio Created in NX6.0.0. More...

void	SetDecalName (const NXString &decalName)
	Sets the decal name Created in NX6.0.0. More...

void	SetDecalName (const char *decalName)
	Sets the decal name Created in NX6.0.0. More...

void	SetDecalReflectivity (double decalReflectivity)
	Sets the decal reflectivity Created in NX6.0.0. More...

void	SetEnableEngraving (bool enableEngraving)
	Sets the engraving enable toggle Created in NX6.0.0. More...

void	SetEngravingAmplitude (double engravingAmplitude)
	Sets the decal engraving amplitude Created in NX6.0.0. More...

void	SetEngravingSoftness (double engravingSoftness)
	Sets the engraving softness Created in NX6.0.0. More...

void	SetHeightScale (double heightScale)
	Sets the decal height scale Created in NX6.0.0. More...

void	SetIlluminationType (NXOpen::Display::DecalBuilder::DecalIllumination illuminationType)
	Sets the illumination type Created in NX6.0.0. More...

void	SetImage (NXOpen::Display::Image *imageBuilder)
	Sets the image builder Created in NX6.0.0. More...

void	SetImageFilename (const NXString &imageFileName)
	Sets the decal image file name Created in NX6.0.0. More...

void	SetImageFilename (const char *imageFileName)
	Sets the decal image file name Created in NX6.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	SetImageSizeType (NXOpen::Display::DecalBuilder::ImageSize imageSizeType)
	Sets the image size type Created in NX6.0.0. More...

void	SetNormalVector (NXOpen::Direction *normalVector)
	Sets the decal normal vector Created in NX6.0.0. More...

void	SetNormalVectorValue (const NXOpen::Vector3d &normalVectorValue)
	Sets the decal normal vector value Created in NX6.0.0. More...

void	SetOrigin (NXOpen::Point *origin)
	Sets the origin Created in NX6.0.0. More...

void	SetOriginPosition (const NXOpen::Point3d &originPosition)
	Sets the origin_pos Created in NX6.0.0. More...

void	SetOverwriteExistingFile (bool overwriteExistingFile)
	Sets the overwrite existing file option - true to overwrite and return no error, false to return error Created in NX10.0.3. More...

void	SetReflectivityType (NXOpen::Display::DecalBuilder::DecalReflectivities reflectivityType)
	Sets the reflectivity type Created in NX10.0.2. More...

void	SetRotation (double rotation)
	Sets the decal rotation Created in NX6.0.0. More...

void	SetScale (double scale)
	Sets the decal scale Created in NX6.0.0. More...

void	SetScalingType (NXOpen::Display::DecalBuilder::Scaling scalingType)
	Sets the scaling type Created in NX6.0.0. More...

void	SetStencilPreview (bool stencilPreview)
	Sets the stencil preview toggle Created in NX6.0.0. More...

void	SetTransparencyColor (const std::vector< double > &transparencyColor)
	Sets the transparency color Created in NX6.0.0. More...

void	SetTransparencyTolerance (int transparencyTolerance)
	Sets the transparency tolerance Created in NX6.0.0. More...

void	SetUpVector (NXOpen::Direction *upVector)
	Sets the decal up vector Created in NX6.0.0. More...

void	SetUpVectorValue (const NXOpen::Vector3d &upVectorValue)
	Sets the decal up vector value Created in NX6.0.0. More...

void	SetWidthScale (double widthScale)
	Sets the decal width scale Created in NX6.0.0. More...

bool	StencilPreview ()
	Returns the stencil preview toggle Created in NX6.0.0. More...

int	TransparencyTolerance ()
	Returns the transparency tolerance Created in NX6.0.0. More...

NXOpen::Direction *	UpVector ()
	Returns the decal up vector Created in NX6.0.0. More...

NXOpen::Vector3d	UpVectorValue ()
	Returns the decal up vector value Created in NX6.0.0. More...

double	WidthScale ()
	Returns the decal width scale Created in NX6.0.0. 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

Represents a NXOpen::Display::DecalBuilder
This class is restricted to being called from a program running during an Interactive NX session.

If run from a non-interactive session it will return NULL.

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Display::DecalBuilder::Anchor

image anchor

Enumerator
AnchorTopLeft	anchor at top left corner of decal image
AnchorCenter	anchor in the middle of decal image
AnchorBottomLeft	anchor at the bottom left corner of decal image
AnchorTopMiddle	anchor at top middle corner of decal image
AnchorTopRight	anchor at top right corner of decal image
AnchorLeftMiddle	anchor at left middle corner of decal image
AnchorRightMiddle	anchor at right middle corner of decal image
AnchorBottomMiddle	anchor at bottom middle corner of decal image
AnchorBottomRight	anchor at bottom right corner of decal image

enum NXOpen::Display::DecalBuilder::DecalIllumination

decal illumination type

Enumerator
DecalIlluminationUseUnderlyingMaterial	base decal reflectivity on underlying material
DecalIlluminationUseDecalMaterial	set decal's reflectivity

enum NXOpen::Display::DecalBuilder::DecalReflectivities

decal reflectivity type

Enumerator
DecalReflectivitiesUseMatte	use matte
DecalReflectivitiesUsePlastic	use plastic
DecalReflectivitiesUseMirror	use mirror
DecalReflectivitiesUseMetal	use metal
DecalReflectivitiesUseGlass	use glass

enum NXOpen::Display::DecalBuilder::ImageSize

image size type

Enumerator
ImageSizeTrueSize	use true image size
ImageSizeOneTwentyEight	resize image to 128 x 128
ImageSizeTwoFiftySix	resize iamge to 256 x 256
ImageSizeFiveTwelve	resize image to 512 x 512
ImageSizeOneOTwoFour	resize image to 1024 x1024
ImageSizeTwoOFourEight	resize image to 2048x2048
ImageSizeFourONineSix	resize image to 4096x 4096

enum NXOpen::Display::DecalBuilder::Scaling

decal scaling type

Enumerator
ScalingToFace	scale the decal based on face size
ScalingToImageSize	scale the decal based on true decal image size
ScalingToUniformScale	scale the decal based on uniform scale
ScalingToNonUniformScale	scale the decal based on both width and height scale

Member Function Documentation

NXOpen::Display::DecalBuilder::Anchor NXOpen::Display::DecalBuilder::AnchorType ( )

Returns the anchor type
Created in NX6.0.0.

License requirements : None

double NXOpen::Display::DecalBuilder::AspectRatio ( )

Returns the decal image aspect ratio
Created in NX6.0.0.

License requirements : None

NXString NXOpen::Display::DecalBuilder::DecalName ( )

Returns the decal name
Created in NX6.0.0.

License requirements : None

double NXOpen::Display::DecalBuilder::DecalReflectivity ( )

Returns the decal reflectivity
Created in NX6.0.0.

License requirements : None

bool NXOpen::Display::DecalBuilder::EnableEngraving ( )

Returns the engraving enable toggle
Created in NX6.0.0.

License requirements : None

double NXOpen::Display::DecalBuilder::EngravingAmplitude ( )

Returns the decal engraving amplitude
Created in NX6.0.0.

License requirements : None

double NXOpen::Display::DecalBuilder::EngravingSoftness ( )

Returns the engraving softness
Created in NX6.0.0.

License requirements : None

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

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

Returns: Array of NXOpen::Display::ImageData names
Created in NX10.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::Display::DecalBuilder::GetObject ( )

Returns the object currently being edited by this builder.

If a new object is being created, and the builder has not yet been commited, returns NULL.

Returns: Created in NX4.0.0.

License requirements : None

std::vector<double> NXOpen::Display::DecalBuilder::GetTransparencyColor ( )

Returns the transparency color.

Returns: Created in NX6.0.0.

License requirements : None

double NXOpen::Display::DecalBuilder::HeightScale ( )

Returns the decal height scale
Created in NX6.0.0.

License requirements : None

NXOpen::Display::DecalBuilder::DecalIllumination NXOpen::Display::DecalBuilder::IlluminationType ( )

Returns the illumination type
Created in NX6.0.0.

License requirements : None

NXOpen::Display::Image* NXOpen::Display::DecalBuilder::Image ( )

Returns the image builder
Created in NX6.0.0.

License requirements : None

NXString NXOpen::Display::DecalBuilder::ImageFilename ( )

Returns the decal image file name
Created in NX6.0.0.

License requirements : None

NXOpen::Display::DecalBuilder::ImageSize NXOpen::Display::DecalBuilder::ImageSizeType ( )

Returns the image size type
Created in NX6.0.0.

License requirements : None

NXOpen::Direction* NXOpen::Display::DecalBuilder::NormalVector ( )

Returns the decal normal vector
Created in NX6.0.0.

License requirements : None

NXOpen::Vector3d NXOpen::Display::DecalBuilder::NormalVectorValue ( )

Returns the decal normal vector value
Created in NX6.0.0.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Display::DecalBuilder::Object ( )

Returns the object(face, body and facetted body) to apply the decal to
Created in NX6.0.0.

License requirements : None

NXOpen::Point* NXOpen::Display::DecalBuilder::Origin ( )

Returns the origin
Created in NX6.0.0.

License requirements : None

NXOpen::Point3d NXOpen::Display::DecalBuilder::OriginPosition ( )

Returns the origin_pos
Created in NX6.0.0.

License requirements : None

bool NXOpen::Display::DecalBuilder::OverwriteExistingFile ( )

Returns the overwrite existing file option - true to overwrite and return no error, false to return error
Created in NX10.0.3.

License requirements : None

NXOpen::Display::DecalBuilder::DecalReflectivities NXOpen::Display::DecalBuilder::ReflectivityType ( )

Returns the reflectivity type
Created in NX10.0.2.

License requirements : None

double NXOpen::Display::DecalBuilder::Rotation ( )

Returns the decal rotation
Created in NX6.0.0.

License requirements : None

double NXOpen::Display::DecalBuilder::Scale ( )

Returns the decal scale
Created in NX6.0.0.

License requirements : None

NXOpen::Display::DecalBuilder::Scaling NXOpen::Display::DecalBuilder::ScalingType ( )

Returns the scaling type
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::DecalBuilder::SetAnchorType ( NXOpen::Display::DecalBuilder::Anchor anchorType )

Sets the anchor type
Created in NX6.0.0.

License requirements : None

Parameters

anchorType anchortype

void NXOpen::Display::DecalBuilder::SetAspectRatio ( double aspectRatio )

Sets the decal image aspect ratio
Created in NX6.0.0.

License requirements : None

Parameters

aspectRatio aspectratio

void NXOpen::Display::DecalBuilder::SetDecalName ( const NXString & decalName )

Sets the decal name
Created in NX6.0.0.

License requirements : None

Parameters

decalName decalname

void NXOpen::Display::DecalBuilder::SetDecalName ( const char * decalName )

Sets the decal name
Created in NX6.0.0.

License requirements : None

Parameters

decalName decalname

void NXOpen::Display::DecalBuilder::SetDecalReflectivity ( double decalReflectivity )

Sets the decal reflectivity
Created in NX6.0.0.

License requirements : None

Parameters

decalReflectivity decalreflectivity

void NXOpen::Display::DecalBuilder::SetEnableEngraving ( bool enableEngraving )

Sets the engraving enable toggle
Created in NX6.0.0.

License requirements : None

Parameters

enableEngraving enableengraving

void NXOpen::Display::DecalBuilder::SetEngravingAmplitude ( double engravingAmplitude )

Sets the decal engraving amplitude
Created in NX6.0.0.

License requirements : None

Parameters

engravingAmplitude engravingamplitude

void NXOpen::Display::DecalBuilder::SetEngravingSoftness ( double engravingSoftness )

Sets the engraving softness
Created in NX6.0.0.

License requirements : None

Parameters

engravingSoftness engravingsoftness

void NXOpen::Display::DecalBuilder::SetHeightScale ( double heightScale )

Sets the decal height scale
Created in NX6.0.0.

License requirements : None

Parameters

heightScale height scale

void NXOpen::Display::DecalBuilder::SetIlluminationType ( NXOpen::Display::DecalBuilder::DecalIllumination illuminationType )

Sets the illumination type
Created in NX6.0.0.

License requirements : None

Parameters

illuminationType illuminationtype

void NXOpen::Display::DecalBuilder::SetImage ( NXOpen::Display::Image * imageBuilder )

Sets the image builder
Created in NX6.0.0.

License requirements : None

Parameters

imageBuilder image builder

void NXOpen::Display::DecalBuilder::SetImageFilename ( const NXString & imageFileName )

Sets the decal image file name
Created in NX6.0.0.

License requirements : None

Parameters

imageFileName image file name

void NXOpen::Display::DecalBuilder::SetImageFilename ( const char * imageFileName )

Sets the decal image file name
Created in NX6.0.0.

License requirements : None

Parameters

imageFileName image file name

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

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

Created in NX10.0.0.

License requirements : None

Parameters

imageName Name of NXOpen::Display::ImageData object

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

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

Created in NX10.0.0.

License requirements : None

Parameters

imageName Name of NXOpen::Display::ImageData object

void NXOpen::Display::DecalBuilder::SetImageSizeType ( NXOpen::Display::DecalBuilder::ImageSize imageSizeType )

Sets the image size type
Created in NX6.0.0.

License requirements : None

Parameters

imageSizeType imagesizetype

void NXOpen::Display::DecalBuilder::SetNormalVector ( NXOpen::Direction * normalVector )

Sets the decal normal vector
Created in NX6.0.0.

License requirements : None

Parameters

normalVector normalvector

void NXOpen::Display::DecalBuilder::SetNormalVectorValue ( const NXOpen::Vector3d & normalVectorValue )

Sets the decal normal vector value
Created in NX6.0.0.

License requirements : None

Parameters

normalVectorValue normalvectorvalue

void NXOpen::Display::DecalBuilder::SetOrigin ( NXOpen::Point * origin )

Sets the origin
Created in NX6.0.0.

License requirements : None

Parameters

origin origin

void NXOpen::Display::DecalBuilder::SetOriginPosition ( const NXOpen::Point3d & originPosition )

Sets the origin_pos
Created in NX6.0.0.

License requirements : None

Parameters

originPosition originposition

void NXOpen::Display::DecalBuilder::SetOverwriteExistingFile ( bool overwriteExistingFile )

Sets the overwrite existing file option - true to overwrite and return no error, false to return error
Created in NX10.0.3.

License requirements : None

Parameters

overwriteExistingFile overwrite existing file

void NXOpen::Display::DecalBuilder::SetReflectivityType ( NXOpen::Display::DecalBuilder::DecalReflectivities reflectivityType )

Sets the reflectivity type
Created in NX10.0.2.

License requirements : None

Parameters

reflectivityType reflectivitytype

void NXOpen::Display::DecalBuilder::SetRotation ( double rotation )

Sets the decal rotation
Created in NX6.0.0.

License requirements : None

Parameters

rotation rotation

void NXOpen::Display::DecalBuilder::SetScale ( double scale )

Sets the decal scale
Created in NX6.0.0.

License requirements : None

Parameters

scale scale

void NXOpen::Display::DecalBuilder::SetScalingType ( NXOpen::Display::DecalBuilder::Scaling scalingType )

Sets the scaling type
Created in NX6.0.0.

License requirements : None

Parameters

scalingType scalingtype

void NXOpen::Display::DecalBuilder::SetStencilPreview ( bool stencilPreview )

Sets the stencil preview toggle
Created in NX6.0.0.

License requirements : None

Parameters

stencilPreview stencilpreview

void NXOpen::Display::DecalBuilder::SetTransparencyColor ( const std::vector< double > & transparencyColor )

Sets the transparency color
Created in NX6.0.0.

License requirements : None

Parameters

transparencyColor transparencycolor

void NXOpen::Display::DecalBuilder::SetTransparencyTolerance ( int transparencyTolerance )

Sets the transparency tolerance
Created in NX6.0.0.

License requirements : None

Parameters

transparencyTolerance transparencytolerance

void NXOpen::Display::DecalBuilder::SetUpVector ( NXOpen::Direction * upVector )

Sets the decal up vector
Created in NX6.0.0.

License requirements : None

Parameters

upVector upvector

void NXOpen::Display::DecalBuilder::SetUpVectorValue ( const NXOpen::Vector3d & upVectorValue )

Sets the decal up vector value
Created in NX6.0.0.

License requirements : None

Parameters

upVectorValue upvectorvalue

void NXOpen::Display::DecalBuilder::SetWidthScale ( double widthScale )

Sets the decal width scale
Created in NX6.0.0.

License requirements : None

Parameters

widthScale width scale

bool NXOpen::Display::DecalBuilder::StencilPreview ( )

Returns the stencil preview toggle
Created in NX6.0.0.

License requirements : None

int NXOpen::Display::DecalBuilder::TransparencyTolerance ( )

Returns the transparency tolerance
Created in NX6.0.0.

License requirements : None

NXOpen::Direction* NXOpen::Display::DecalBuilder::UpVector ( )

Returns the decal up vector
Created in NX6.0.0.

License requirements : None

NXOpen::Vector3d NXOpen::Display::DecalBuilder::UpVectorValue ( )

Returns the decal up vector value
Created in NX6.0.0.

License requirements : None

double NXOpen::Display::DecalBuilder::WidthScale ( )

Returns the decal width scale
Created in NX6.0.0.

License requirements : None

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

Display_DecalBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation