Represents a NXOpen.Display.DecalBuilder More...

Inheritance diagram for NXOpen.Display.DecalBuilder:

Public Types
enum	Anchor { TopLeft, Center, BottomLeft, TopMiddle, TopRight, LeftMiddle, RightMiddle, BottomMiddle, BottomRight }
	image anchor More...

enum	DecalIllumination { UseUnderlyingMaterial, UseDecalMaterial }
	decal illumination type More...

enum	DecalReflectivities { UseMatte, UsePlastic, UseMirror, UseMetal, UseGlass }
	decal reflectivity type More...

enum	ImageSize { TrueSize, OneTwentyEight, TwoFiftySix, FiveTwelve, OneOTwoFour, TwoOFourEight, FourONineSix }
	image size type More...

enum	Projection { Planar, Cylindrical, Spherical, Uv }
	decal projection type More...

enum	Scaling { ToFace, ToImageSize, ToUniformScale, ToNonUniformScale }
	decal scaling type More...

Public Member Functions
unsafe string[]	GetImagesInPart ()
	Provide a list of names of the NXOpen.Display.ImageData objects saved in current part file. More...

unsafe double[]	GetTransparencyColor ()
	Returns the transparency color More...

unsafe void	SetImageFromPart (string imageName)
	Set a NXOpen.Display.ImageData object currently stored in the part as the image used by the builder. More...

unsafe void	SetTransparencyColor (double[] transparencyColor)
	Sets the transparency color More...

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

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

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

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

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

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

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.Display.DecalBuilder.Anchor	AnchorType `[get, set]`
	Returns or sets the anchor type More...

unsafe double	AspectRatio `[get, set]`
	Returns or sets the decal image aspect ratio More...

unsafe double	AxialRotation `[get, set]`
	Returns or sets the decal axial rotation More...

unsafe string	DecalName `[get, set]`
	Returns or sets the decal name More...

unsafe double	DecalReflectivity `[get, set]`
	Returns or sets the decal reflectivity More...

unsafe bool	EnableEngraving `[get, set]`
	Returns or sets the engraving enable toggle More...

unsafe double	EngravingAmplitude `[get, set]`
	Returns or sets the decal engraving amplitude More...

unsafe double	EngravingSoftness `[get, set]`
	Returns or sets the engraving softness More...

unsafe double	HeightScale `[get, set]`
	Returns or sets the decal height scale More...

unsafe NXOpen.Display.DecalBuilder.DecalIllumination	IlluminationType `[get, set]`
	Returns or sets the illumination type More...

unsafe NXOpen.Display.Image	Image `[get, set]`
	Returns or sets the image builder More...

unsafe string	ImageFilename `[get, set]`
	Returns or sets the decal image file name More...

unsafe NXOpen.Display.DecalBuilder.ImageSize	ImageSizeType `[get, set]`
	Returns or sets the image size type More...

unsafe NXOpen.Direction	NormalVector `[get, set]`
	Returns or sets the decal normal vector More...

unsafe NXOpen.Vector3d	NormalVectorValue `[get, set]`
	Returns or sets the decal normal vector value More...

unsafe NXOpen.SelectNXObjectList	Object `[get]`
	Returns the object(face, body and facetted body) to apply the decal to More...

unsafe NXOpen.Point	Origin `[get, set]`
	Returns or sets the origin More...

unsafe NXOpen.Point3d	OriginPosition `[get, set]`
	Returns or sets the origin_pos More...

unsafe bool	OverwriteExistingFile `[get, set]`
	Returns or sets the overwrite existing file option - true to overwrite and return no error, false to return error More...

unsafe NXOpen.Display.DecalBuilder.Projection	ProjectionType `[get, set]`
	Returns or sets the projection type More...

unsafe NXOpen.Display.DecalBuilder.DecalReflectivities	ReflectivityType `[get, set]`
	Returns or sets the reflectivity type More...

unsafe double	Rotation `[get, set]`
	Returns or sets the decal rotation More...

unsafe double	RotationX `[get, set]`
	Returns or sets the X value of rotation around the origin point More...

unsafe double	RotationY `[get, set]`
	Returns or sets the Y value of rotation around the origin point More...

unsafe double	RotationZ `[get, set]`
	Returns or sets the Z value of rotation around the origin point More...

unsafe double	Scale `[get, set]`
	Returns or sets the decal scale More...

unsafe NXOpen.Display.DecalBuilder.Scaling	ScalingType `[get, set]`
	Returns or sets the scaling type More...

unsafe bool	StencilPreview `[get, set]`
	Returns or sets the stencil preview toggle More...

unsafe double	TranslationX `[get, set]`
	Returns or sets the X direction of translation More...

unsafe double	TranslationY `[get, set]`
	Returns or sets the Y direction of translation More...

unsafe double	TranslationZ `[get, set]`
	Returns or sets the Z direction of translation More...

unsafe int	TransparencyTolerance `[get, set]`
	Returns or sets the transparency tolerance More...

unsafe NXOpen.Direction	UpVector `[get, set]`
	Returns or sets the decal up vector More...

unsafe NXOpen.Vector3d	UpVectorValue `[get, set]`
	Returns or sets the decal up vector value More...

unsafe double	WidthScale `[get, set]`
	Returns or sets the decal width scale More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> 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 a null reference (Nothing in Visual Basic).

Created in NX6.0.0

Member Enumeration Documentation

enum NXOpen.Display.DecalBuilder.Anchor

image anchor

Enumerator
TopLeft	anchor at top left corner of decal image
Center	anchor in the middle of decal image
BottomLeft	anchor at the bottom left corner of decal image
TopMiddle	anchor at top middle corner of decal image
TopRight	anchor at top right corner of decal image
LeftMiddle	anchor at left middle corner of decal image
RightMiddle	anchor at right middle corner of decal image
BottomMiddle	anchor at bottom middle corner of decal image
BottomRight	anchor at bottom right corner of decal image

enum NXOpen.Display.DecalBuilder.DecalIllumination

decal illumination type

Enumerator
UseUnderlyingMaterial	base decal reflectivity on underlying material
UseDecalMaterial	set decal's reflectivity

enum NXOpen.Display.DecalBuilder.DecalReflectivities

decal reflectivity type

Enumerator
UseMatte
UsePlastic
UseMirror
UseMetal
UseGlass

enum NXOpen.Display.DecalBuilder.ImageSize

image size type

Enumerator
TrueSize	use true image size
OneTwentyEight	resize image to 128 x 128
TwoFiftySix	resize iamge to 256 x 256
FiveTwelve	resize image to 512 x 512
OneOTwoFour	resize image to 1024 x1024
TwoOFourEight	resize image to 2048x2048
FourONineSix	resize image to 4096x 4096

enum NXOpen.Display.DecalBuilder.Projection

decal projection type

Enumerator
Planar	planar projection type
Cylindrical	cylindrical projection type
Spherical	spherical projection type
Uv	UV map projection type

enum NXOpen.Display.DecalBuilder.Scaling

decal scaling type

Enumerator
ToFace	scale the decal based on face size
ToImageSize	scale the decal based on true decal image size
ToUniformScale	scale the decal based on uniform scale
ToNonUniformScale	scale the decal based on both width and height scale

Member Function Documentation

unsafe string [] NXOpen.Display.DecalBuilder.GetImagesInPart ( )

inline

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

Created in NX10.0.0

License requirements: None.

Returns: Array of NXOpen.Display.ImageData names

unsafe double [] NXOpen.Display.DecalBuilder.GetTransparencyColor ( )

inline

Returns the transparency color

Created in NX6.0.0

License requirements: None.

Returns

unsafe void NXOpen.Display.DecalBuilder.SetImageFromPart ( string imageName )

inline

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

unsafe void NXOpen.Display.DecalBuilder.SetTransparencyColor ( double[] transparencyColor )

inline

Sets the transparency color

Created in NX6.0.0

License requirements: None.

Parameters

transparencyColor

Property Documentation

unsafe NXOpen.Display.DecalBuilder.Anchor NXOpen.Display.DecalBuilder.AnchorType

getset

Returns or sets the anchor type

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.DecalBuilder.AspectRatio

getset

Returns or sets the decal image aspect ratio

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.DecalBuilder.AxialRotation

getset

Returns or sets the decal axial rotation

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Display.DecalBuilder.DecalName

getset

Returns or sets the decal name

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.DecalBuilder.DecalReflectivity

getset

Returns or sets the decal reflectivity

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.DecalBuilder.EnableEngraving

getset

Returns or sets the engraving enable toggle

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.DecalBuilder.EngravingAmplitude

getset

Returns or sets the decal engraving amplitude

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.DecalBuilder.EngravingSoftness

getset

Returns or sets the engraving softness

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.DecalBuilder.HeightScale

getset

Returns or sets the decal height scale

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.DecalBuilder.DecalIllumination NXOpen.Display.DecalBuilder.IlluminationType

getset

Returns or sets the illumination type

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.Image NXOpen.Display.DecalBuilder.Image

getset

Returns or sets the image builder

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Display.DecalBuilder.ImageFilename

getset

Returns or sets the decal image file name

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.DecalBuilder.ImageSize NXOpen.Display.DecalBuilder.ImageSizeType

getset

Returns or sets the image size type

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Direction NXOpen.Display.DecalBuilder.NormalVector

getset

Returns or sets the decal normal vector

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Vector3d NXOpen.Display.DecalBuilder.NormalVectorValue

getset

Returns or sets the decal normal vector value

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.SelectNXObjectList NXOpen.Display.DecalBuilder.Object

get

Returns the object(face, body and facetted body) to apply the decal to

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Point NXOpen.Display.DecalBuilder.Origin

getset

Returns or sets the origin

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point3d NXOpen.Display.DecalBuilder.OriginPosition

getset

Returns or sets the origin_pos

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.DecalBuilder.OverwriteExistingFile

getset

Returns or sets the overwrite existing file option - true to overwrite and return no error, false to return error

Created in NX10.0.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.DecalBuilder.Projection NXOpen.Display.DecalBuilder.ProjectionType

getset

Returns or sets the projection type

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.DecalBuilder.DecalReflectivities NXOpen.Display.DecalBuilder.ReflectivityType

getset

Returns or sets the reflectivity type

Created in NX10.0.2

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.DecalBuilder.Rotation

getset

Returns or sets the decal rotation

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.DecalBuilder.RotationX

getset

Returns or sets the X value of rotation around the origin point

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.DecalBuilder.RotationY

getset

Returns or sets the Y value of rotation around the origin point

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.DecalBuilder.RotationZ

getset

Returns or sets the Z value of rotation around the origin point

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.DecalBuilder.Scale

getset

Returns or sets the decal scale

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.DecalBuilder.Scaling NXOpen.Display.DecalBuilder.ScalingType

getset

Returns or sets the scaling type

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.DecalBuilder.StencilPreview

getset

Returns or sets the stencil preview toggle

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.DecalBuilder.TranslationX

getset

Returns or sets the X direction of translation

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.DecalBuilder.TranslationY

getset

Returns or sets the Y direction of translation

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.DecalBuilder.TranslationZ

getset

Returns or sets the Z direction of translation

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Display.DecalBuilder.TransparencyTolerance

getset

Returns or sets the transparency tolerance

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Direction NXOpen.Display.DecalBuilder.UpVector

getset

Returns or sets the decal up vector

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Vector3d NXOpen.Display.DecalBuilder.UpVectorValue

getset

Returns or sets the decal up vector value

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.DecalBuilder.WidthScale

getset

Returns or sets the decal width scale

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

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

Display_DecalBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation