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

Inheritance diagram for NXOpen::Display::CgfxMattexBuilder:

Public Types
enum	Technique { TechniqueBase }
	The technique is an index to a technique name in a list found in the CgFX file. More...

enum	TextureSpace { TextureSpaceDefaultUv, TextureSpaceEdited }
	The texture space type indicates the texture space type to use for CgFX shader. More...

enum	TextureSpaceShader { TextureSpaceShaderArbitraryPlane, TextureSpaceShaderCylindrical, TextureSpaceShaderSpherical, TextureSpaceShaderWcsAutoAxis, TextureSpaceShaderUv, TextureSpaceShaderCameraDirectionPlane }
	The texture space shader type indicates the type of texture space shader to use for CgFX shader. More...

enum	UseCameraDirectionPlane { UseCameraDirectionPlaneNormalVector, UseCameraDirectionPlaneNormalAndUpVector }
	The option indicates which texture space vectors are updated upon Update Texture to Camera Direction action. More...

Public Member Functions
std::vector< NXOpen::NXObject * >	GetAttributeValues ()
	Returns the attribute values.

NXString	MaterialName ()
	Returns the material name Created in NX5.0.0.

void	SetAttributeValues (const std::vector< NXOpen::NXObject * > &attributeValues)
	Sets the attribute values Created in NX5.0.0.

void	SetMaterialName (const NXString &materialName)
	Sets the material name Created in NX5.0.0.

void	SetMaterialName (const char *materialName)
	Sets the material name Created in NX5.0.0.

void	SetShadowCastingDisabled (bool disableShadowCasting)
	Sets the flag indicating if shadow casting is disabled Created in NX6.0.5.

void	SetTechniqueType (NXOpen::Display::CgfxMattexBuilder::Technique technique)
	Sets the display techniques Created in NX5.0.0.

void	SetTextureSpaceShaderType (NXOpen::Display::CgfxMattexBuilder::TextureSpaceShader textureSpaceShaderType)
	Sets the texture space shader type Created in NX7.5.2.

void	SetUseCameraDirectionPlaneOption (NXOpen::Display::CgfxMattexBuilder::UseCameraDirectionPlane useCameraDiretionPlaneOption)
	Sets the use camera direction plane option Created in NX7.5.2.

bool	ShadowCastingDisabled ()
	Returns the flag indicating if shadow casting is disabled Created in NX6.0.5.

NXOpen::Display::CgfxMattexBuilder::Technique	TechniqueType ()
	Returns the display techniques Created in NX5.0.0.

NXOpen::Display::CgfxMattexBuilder::TextureSpaceShader	TextureSpaceShaderType ()
	Returns the texture space shader type Created in NX7.5.2.

void	UpdateMaterialsInPartPaletteEntry ()
	This is used to update the materials in part palette entry Created in NX8.0.1.

NXOpen::Display::CgfxMattexBuilder::UseCameraDirectionPlane	UseCameraDirectionPlaneOption ()
	Returns the use camera direction plane option Created in NX7.5.2.

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.

Detailed Description

Represents a Display::CgfxMattex builder
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 NX5.0.0.

Member Enumeration Documentation

enum NXOpen::Display::CgfxMattexBuilder::Technique

The technique is an index to a technique name in a list found in the CgFX file.

There is is unknown until the CgFX file is loaded.

Enumerator:

TechniqueBase

place holder for variable technique list

enum NXOpen::Display::CgfxMattexBuilder::TextureSpace

The texture space type indicates the texture space type to use for CgFX shader.

    <br>  NOTE: This is deprecated.  Please use TextureSpaceShader instead.   <br>

Deprecated:: Deprecated in NX7.5.2. Use Display::CgfxMattexBuilder::TextureSpaceShader instead.

Enumerator:

TextureSpaceDefaultUv	scale 1, 0 offset uv texture space
TextureSpaceEdited	the one edited using the material texture dialog

enum NXOpen::Display::CgfxMattexBuilder::TextureSpaceShader

The texture space shader type indicates the type of texture space shader to use for CgFX shader.

Enumerator:

TextureSpaceShaderArbitraryPlane	based on specified plane
TextureSpaceShaderCylindrical	for cylindrical model
TextureSpaceShaderSpherical	for spherical geometry
TextureSpaceShaderWcsAutoAxis	auto tri plane
TextureSpaceShaderUv	scale 1, 0 offset uv texture space
TextureSpaceShaderCameraDirectionPlane	scale 1, 0 offset uv texture space

enum NXOpen::Display::CgfxMattexBuilder::UseCameraDirectionPlane

The option indicates which texture space vectors are updated upon Update Texture to Camera Direction action.

Enumerator:

UseCameraDirectionPlaneNormalVector	normal vector is updated based on camera direction
UseCameraDirectionPlaneNormalAndUpVector	both normal and up vectors are updated based on camera direction

Member Function Documentation

std::vector<NXOpen::NXObject *> NXOpen::Display::CgfxMattexBuilder::GetAttributeValues ( )

Returns the attribute values.

Returns: Created in NX5.0.0.

License requirements : None

NXString NXOpen::Display::CgfxMattexBuilder::MaterialName ( )

Returns the material name
Created in NX5.0.0.

License requirements : None

void NXOpen::Display::CgfxMattexBuilder::SetAttributeValues ( const std::vector< NXOpen::NXObject * > & attributeValues )

Sets the attribute values
Created in NX5.0.0.

License requirements : None

Parameters

attributeValues attribute values

void NXOpen::Display::CgfxMattexBuilder::SetMaterialName ( const NXString & materialName )

Sets the material name
Created in NX5.0.0.

License requirements : None

Parameters

materialName materialname

void NXOpen::Display::CgfxMattexBuilder::SetMaterialName ( const char * materialName )

Sets the material name
Created in NX5.0.0.

License requirements : None

Parameters

materialName materialname

void NXOpen::Display::CgfxMattexBuilder::SetShadowCastingDisabled ( bool disableShadowCasting )

Sets the flag indicating if shadow casting is disabled
Created in NX6.0.5.

License requirements : None

Parameters

disableShadowCasting disableshadowcasting

void NXOpen::Display::CgfxMattexBuilder::SetTechniqueType ( NXOpen::Display::CgfxMattexBuilder::Technique technique )

Sets the display techniques
Created in NX5.0.0.

License requirements : None

Parameters

technique technique

void NXOpen::Display::CgfxMattexBuilder::SetTextureSpaceShaderType ( NXOpen::Display::CgfxMattexBuilder::TextureSpaceShader textureSpaceShaderType )

Sets the texture space shader type
Created in NX7.5.2.

License requirements : None

Parameters

textureSpaceShaderType texture space shader type

void NXOpen::Display::CgfxMattexBuilder::SetUseCameraDirectionPlaneOption ( NXOpen::Display::CgfxMattexBuilder::UseCameraDirectionPlane useCameraDiretionPlaneOption )

Sets the use camera direction plane option
Created in NX7.5.2.

License requirements : None

Parameters

useCameraDiretionPlaneOption use camera diretion plane option

bool NXOpen::Display::CgfxMattexBuilder::ShadowCastingDisabled ( )

Returns the flag indicating if shadow casting is disabled
Created in NX6.0.5.

License requirements : None

NXOpen::Display::CgfxMattexBuilder::Technique NXOpen::Display::CgfxMattexBuilder::TechniqueType ( )

Returns the display techniques
Created in NX5.0.0.

License requirements : None

NXOpen::Display::CgfxMattexBuilder::TextureSpaceShader NXOpen::Display::CgfxMattexBuilder::TextureSpaceShaderType ( )

Returns the texture space shader type
Created in NX7.5.2.

License requirements : None

void NXOpen::Display::CgfxMattexBuilder::UpdateMaterialsInPartPaletteEntry ( )

This is used to update the materials in part palette entry
Created in NX8.0.1.

License requirements : None

NXOpen::Display::CgfxMattexBuilder::UseCameraDirectionPlane NXOpen::Display::CgfxMattexBuilder::UseCameraDirectionPlaneOption ( )

Returns the use camera direction plane option
Created in NX7.5.2.

License requirements : None

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

Display_CgfxMattexBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation