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

Represents a Display::CgfxMattex builder


Created in NX5.0.0. More...

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

List of all members.

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 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 SetTextureSpaceType (NXOpen::Display::CgfxMattexBuilder::TextureSpace textureSpaceType)
 Sets the texture space type.
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.
NXOpen::Display::CgfxMattexBuilder::TextureSpace TextureSpaceType ()
 Returns the texture space type.
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.

Detailed Description

Represents a Display::CgfxMattex builder


Created in NX5.0.0.



Member Enumeration Documentation

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

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


NOTE: This is deprecated. Please use TextureSpaceShader instead.


Deprecated:
Deprecated in NX7.5.2.
Enumerator:
TextureSpaceDefaultUv 

scale 1, 0 offset uv texture space

TextureSpaceEdited 

the one edited using the material texture dialog

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

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

Returns the attribute values.

Returns:

Created in NX5.0.0.

License requirements : None

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:
attributeValuesattribute values

Sets the material name
Created in NX5.0.0.



License requirements : None

Parameters:
materialNamematerialname

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



License requirements : None

Parameters:
disableShadowCastingdisableshadowcasting

Sets the display techniques
Created in NX5.0.0.



License requirements : None

Parameters:
techniquetechnique

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



License requirements : None

Parameters:
textureSpaceShaderTypetexture space shader type

Sets the texture space type.


NOTE: These APIs are deprecated. Please use get and setTextureSpaceShaderType.


Deprecated:
Deprecated in NX7.5.2.


Created in NX5.0.0.

License requirements : None

Parameters:
textureSpaceTypetexture space type

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



License requirements : None

Parameters:
useCameraDiretionPlaneOptionuse camera diretion plane option

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



License requirements : None

Returns the display techniques
Created in NX5.0.0.



License requirements : None

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



License requirements : None

Returns the texture space type.


NOTE: These APIs are deprecated. Please use get and setTextureSpaceShaderType.


Deprecated:
Deprecated in NX7.5.2.


Created in NX5.0.0.

License requirements : None

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



License requirements : None

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.