NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Display::DecalBuilder Class Reference

Represents a Display::DecalBuilder


Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Display::DecalBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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  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.
double AspectRatio ()
 Returns the decal image aspect ratio
Created in NX6.0.0.
NXString DecalName ()
 Returns the decal name
Created in NX6.0.0.
double DecalReflectivity ()
 Returns the decal reflectivity
Created in NX6.0.0.
bool EnableEngraving ()
 Returns the engraving enable toggle
Created in NX6.0.0.
double EngravingAmplitude ()
 Returns the decal engraving amplitude
Created in NX6.0.0.
double EngravingSoftness ()
 Returns the engraving softness
Created in NX6.0.0.
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder.
std::vector< double > GetTransparencyColor ()
 Returns the transparency color.
double HeightScale ()
 Returns the decal height scale
Created in NX6.0.0.
NXOpen::Display::DecalBuilder::DecalIllumination IlluminationType ()
 Returns the illumination type
Created in NX6.0.0.
NXOpen::Display::ImageImage ()
 Returns the image builder
Created in NX6.0.0.
NXString ImageFilename ()
 Returns the decal image file name
Created in NX6.0.0.
NXOpen::Display::DecalBuilder::ImageSize ImageSizeType ()
 Returns the image size type
Created in NX6.0.0.
NXOpen::DirectionNormalVector ()
 Returns the decal normal vector
Created in NX6.0.0.
NXOpen::Vector3d NormalVectorValue ()
 Returns the decal normal vector value
Created in NX6.0.0.
NXOpen::SelectNXObjectListObject ()
 Returns the object(face, body and facetted body) to apply the decal to
Created in NX6.0.0.
NXOpen::PointOrigin ()
 Returns the origin
Created in NX6.0.0.
NXOpen::Point3d OriginPosition ()
 Returns the origin_pos
Created in NX6.0.0.
double Rotation ()
 Returns the decal rotation
Created in NX6.0.0.
double Scale ()
 Returns the decal scale
Created in NX6.0.0.
NXOpen::Display::DecalBuilder::Scaling ScalingType ()
 Returns the scaling type
Created in NX6.0.0.
void SetAnchorType (NXOpen::Display::DecalBuilder::Anchor anchorType)
 Sets the anchor type
Created in NX6.0.0.
void SetAspectRatio (double aspectRatio)
 Sets the decal image aspect ratio
Created in NX6.0.0.
void SetDecalName (const NXString &decalName)
 Sets the decal name
Created in NX6.0.0.
void SetDecalReflectivity (double decalReflectivity)
 Sets the decal reflectivity
Created in NX6.0.0.
void SetEnableEngraving (bool enableEngraving)
 Sets the engraving enable toggle
Created in NX6.0.0.
void SetEngravingAmplitude (double engravingAmplitude)
 Sets the decal engraving amplitude
Created in NX6.0.0.
void SetEngravingSoftness (double engravingSoftness)
 Sets the engraving softness
Created in NX6.0.0.
void SetHeightScale (double heightScale)
 Sets the decal height scale
Created in NX6.0.0.
void SetIlluminationType (NXOpen::Display::DecalBuilder::DecalIllumination illuminationType)
 Sets the illumination type
Created in NX6.0.0.
void SetImage (NXOpen::Display::Image *imageBuilder)
 Sets the image builder
Created in NX6.0.0.
void SetImageFilename (const NXString &imageFileName)
 Sets the decal image file name
Created in NX6.0.0.
void SetImageSizeType (NXOpen::Display::DecalBuilder::ImageSize imageSizeType)
 Sets the image size type
Created in NX6.0.0.
void SetNormalVector (NXOpen::Direction *normalVector)
 Sets the decal normal vector
Created in NX6.0.0.
void SetNormalVectorValue (const NXOpen::Vector3d &normalVectorValue)
 Sets the decal normal vector value
Created in NX6.0.0.
void SetOrigin (NXOpen::Point *origin)
 Sets the origin
Created in NX6.0.0.
void SetOriginPosition (const NXOpen::Point3d &originPosition)
 Sets the origin_pos
Created in NX6.0.0.
void SetRotation (double rotation)
 Sets the decal rotation
Created in NX6.0.0.
void SetScale (double scale)
 Sets the decal scale
Created in NX6.0.0.
void SetScalingType (NXOpen::Display::DecalBuilder::Scaling scalingType)
 Sets the scaling type
Created in NX6.0.0.
void SetStencilPreview (bool stencilPreview)
 Sets the stencil preview toggle
Created in NX6.0.0.
void SetTransparencyColor (const std::vector< double > &transparencyColor)
 Sets the transparency color
Created in NX6.0.0.
void SetTransparencyTolerance (int transparencyTolerance)
 Sets the transparency tolerance
Created in NX6.0.0.
void SetUpVector (NXOpen::Direction *upVector)
 Sets the decal up vector
Created in NX6.0.0.
void SetUpVectorValue (const NXOpen::Vector3d &upVectorValue)
 Sets the decal up vector value
Created in NX6.0.0.
void SetWidthScale (double widthScale)
 Sets the decal width scale
Created in NX6.0.0.
bool StencilPreview ()
 Returns the stencil preview toggle
Created in NX6.0.0.
int TransparencyTolerance ()
 Returns the transparency tolerance
Created in NX6.0.0.
NXOpen::DirectionUpVector ()
 Returns the decal up vector
Created in NX6.0.0.
NXOpen::Vector3d UpVectorValue ()
 Returns the decal up vector value
Created in NX6.0.0.
double WidthScale ()
 Returns the decal width scale
Created in NX6.0.0.

Detailed Description

Represents a Display::DecalBuilder


Created in NX6.0.0.



Member Enumeration Documentation

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

decal illumination type

Enumerator:
DecalIlluminationUseUnderlyingMaterial 

base decal reflectivity on underlying material

DecalIlluminationUseDecalMaterial 

set decal's reflectivity

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

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

Returns the anchor type
Created in NX6.0.0.



License requirements : None

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



License requirements : None

Returns the decal name
Created in NX6.0.0.



License requirements : None

Returns the decal reflectivity
Created in NX6.0.0.



License requirements : None

Returns the engraving enable toggle
Created in NX6.0.0.



License requirements : None

Returns the decal engraving amplitude
Created in NX6.0.0.



License requirements : None

Returns the engraving softness
Created in NX6.0.0.



License requirements : None

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

Reimplemented from NXOpen::Builder.

Returns the transparency color.

Returns:

Created in NX6.0.0.

License requirements : None

Returns the decal height scale
Created in NX6.0.0.



License requirements : None

Returns the illumination type
Created in NX6.0.0.



License requirements : None

Returns the image builder
Created in NX6.0.0.



License requirements : None

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



License requirements : None

Returns the image size type
Created in NX6.0.0.



License requirements : None

Returns the decal normal vector
Created in NX6.0.0.



License requirements : None

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



License requirements : None

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



License requirements : None

Returns the origin
Created in NX6.0.0.



License requirements : None

Returns the origin_pos
Created in NX6.0.0.



License requirements : None

Returns the decal rotation
Created in NX6.0.0.



License requirements : None

Returns the decal scale
Created in NX6.0.0.



License requirements : None

Returns the scaling type
Created in NX6.0.0.



License requirements : None

Sets the anchor type
Created in NX6.0.0.



License requirements : None

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

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



License requirements : None

Parameters:
aspectRatioaspectratio

Sets the decal name
Created in NX6.0.0.



License requirements : None

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

Sets the decal reflectivity
Created in NX6.0.0.



License requirements : None

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

Sets the engraving enable toggle
Created in NX6.0.0.



License requirements : None

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

Sets the decal engraving amplitude
Created in NX6.0.0.



License requirements : None

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

Sets the engraving softness
Created in NX6.0.0.



License requirements : None

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

Sets the decal height scale
Created in NX6.0.0.



License requirements : None

Parameters:
heightScaleheight scale

Sets the illumination type
Created in NX6.0.0.



License requirements : None

Parameters:
illuminationTypeilluminationtype

Sets the image builder
Created in NX6.0.0.



License requirements : None

Parameters:
imageBuilderimage builder

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



License requirements : None

Parameters:
imageFileNameimage file name

Sets the image size type
Created in NX6.0.0.



License requirements : None

Parameters:
imageSizeTypeimagesizetype

Sets the decal normal vector
Created in NX6.0.0.



License requirements : None

Parameters:
normalVectornormalvector

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



License requirements : None

Parameters:
normalVectorValuenormalvectorvalue

Sets the origin
Created in NX6.0.0.



License requirements : None

Parameters:
originorigin

Sets the origin_pos
Created in NX6.0.0.



License requirements : None

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

Sets the decal rotation
Created in NX6.0.0.



License requirements : None

Parameters:
rotationrotation

Sets the decal scale
Created in NX6.0.0.



License requirements : None

Parameters:
scalescale

Sets the scaling type
Created in NX6.0.0.



License requirements : None

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

Sets the stencil preview toggle
Created in NX6.0.0.



License requirements : None

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

Sets the transparency color
Created in NX6.0.0.



License requirements : None

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

Sets the transparency tolerance
Created in NX6.0.0.



License requirements : None

Parameters:
transparencyTolerancetransparencytolerance

Sets the decal up vector
Created in NX6.0.0.



License requirements : None

Parameters:
upVectorupvector

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



License requirements : None

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

Sets the decal width scale
Created in NX6.0.0.



License requirements : None

Parameters:
widthScalewidth scale

Returns the stencil preview toggle
Created in NX6.0.0.



License requirements : None

Returns the transparency tolerance
Created in NX6.0.0.



License requirements : None

Returns the decal up vector
Created in NX6.0.0.



License requirements : None

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



License requirements : None

Returns the decal width scale
Created in NX6.0.0.



License requirements : None


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