NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Display.CgfxMattexBuilder Class Reference

Represents a NXOpen.Display.CgfxMattex builder More...

Inheritance diagram for NXOpen.Display.CgfxMattexBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  Technique { Base }
 The technique is an index to a technique name in a list found in the CgFX file. More...
 
enum  TextureSpace { DefaultUv, Edited }
 The texture space type indicates the texture space type to use for CgFX shader. More...
 
enum  TextureSpaceShader {
  ArbitraryPlane, Cylindrical, Spherical, WcsAutoAxis,
  Uv, CameraDirectionPlane
}
 The texture space shader type indicates the type of texture space shader to use for CgFX shader More...
 
enum  UseCameraDirectionPlane { NormalVector, NormalAndUpVector }
 The option indicates which texture space vectors are updated upon Update Texture to Camera Direction action More...
 

Public Member Functions

unsafe NXOpen.NXObject[] GetAttributeValues ()
 Returns the attribute values More...
 
unsafe void SetAttributeValues (NXOpen.NXObject[] attributeValues)
 Sets the attribute values More...
 
unsafe void UpdateMaterialsInPartPaletteEntry ()
 This is used to update the materials in part palette entry 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 string MaterialName [get, set]
 Returns or sets the material name More...
 
unsafe bool ShadowCastingDisabled [get, set]
 Returns or sets the flag indicating if shadow casting is disabled More...
 
unsafe
NXOpen.Display.CgfxMattexBuilder.Technique 
TechniqueType [get, set]
 Returns or sets the display techniques More...
 
unsafe
NXOpen.Display.CgfxMattexBuilder.TextureSpaceShader 
TextureSpaceShaderType [get, set]
 Returns or sets the texture space shader type More...
 
unsafe
NXOpen.Display.CgfxMattexBuilder.UseCameraDirectionPlane 
UseCameraDirectionPlaneOption [get, set]
 Returns or sets the use camera direction plane option More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.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 a null reference (Nothing in Visual Basic).

Created in NX5.0.0

Deprecated in NX10.0.0. No alternative provided for this class.

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
Base 

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.

Enumerator
DefaultUv 

scale 1, 0 offset uv texture space

Edited 

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
ArbitraryPlane 

based on specified plane

Cylindrical 

for cylindrical model

Spherical 

for spherical geometry

WcsAutoAxis 

auto tri plane

Uv 

scale 1, 0 offset uv texture space

CameraDirectionPlane 

scale 1, 0 offset uv texture space

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

Enumerator
NormalVector 

normal vector is updated based on camera direction

NormalAndUpVector 

both normal and up vectors are updated based on camera direction

Member Function Documentation

unsafe NXOpen.NXObject [] NXOpen.Display.CgfxMattexBuilder.GetAttributeValues ( )
inline

Returns the attribute values

Created in NX5.0.0

License requirements: None.

Returns
unsafe void NXOpen.Display.CgfxMattexBuilder.SetAttributeValues ( NXOpen.NXObject[]  attributeValues)
inline

Sets the attribute values

Created in NX5.0.0

License requirements: None.

Parameters
attributeValuesattribute values
unsafe void NXOpen.Display.CgfxMattexBuilder.UpdateMaterialsInPartPaletteEntry ( )
inline

This is used to update the materials in part palette entry

Created in NX8.0.1

License requirements: None.

Property Documentation

unsafe string NXOpen.Display.CgfxMattexBuilder.MaterialName
getset

Returns or sets the material name

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.CgfxMattexBuilder.ShadowCastingDisabled
getset

Returns or sets the flag indicating if shadow casting is disabled

Created in NX6.0.5

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.CgfxMattexBuilder.Technique NXOpen.Display.CgfxMattexBuilder.TechniqueType
getset

Returns or sets the display techniques

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.CgfxMattexBuilder.TextureSpaceShader NXOpen.Display.CgfxMattexBuilder.TextureSpaceShaderType
getset

Returns or sets the texture space shader type

Created in NX7.5.2

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.CgfxMattexBuilder.UseCameraDirectionPlane NXOpen.Display.CgfxMattexBuilder.UseCameraDirectionPlaneOption
getset

Returns or sets the use camera direction plane option

Created in NX7.5.2

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