CSMaterial Object
The CSMaterial Object represents a 3DCrafter Palette Material.
| Translucent | GetTranslucent |
| SetTranslucent |
| Diffuse | GetDiffuse |
| SetDiffuse |
| Ambient | GetAmbient |
| SetAmbient |
| Specular | GetSpecular |
| SetSpecular |
| Secondary Texture | GetSecondaryTextureFileName |
| SetSecondaryTextureFileName | |
| GetSecondaryTextureTranslucent | |
| SetSecondaryTextureTranslucent |
| TranslucentMap | GetTranslucentMapFileName |
| SetTranslucentMapFileName |
| BumpMap | GetBumpMapFileName |
| SetBumpMapFileName |
| SpecularMap | GetSpecularMapFileName |
| SetSpecularMapFileName |
| EnvironmentMap | GetEnvironmentMapFileName |
| SetEnvironmentMapFileName |
| General | GetCustomFieldValue |
| SetCustomFieldValue | |
| GetAlphaTest | |
| SetAlphaTest | |
| GetAlphaTestReference | |
| SetAlphaTestReference | |
| GetDoubleSided | |
| SetDoubleSided |
Gets the material color.
Syntax
shape.GetColor(Red As Variant,
Green As Variant,
Blue As Variant)
Remarks
Each color component may be from 0 to 1 in intensity.
Sets the material color.
Syntax
shape.SetColor(Red As Variant,
Green As Variant,
Blue As Variant)
Remarks
Each color component may be from 0 to 1 in intensity.
Gets the translucent factor.
Sets the
Syntax
shape.GetTranslucent() As Variant
Remarks
May be from 0 to 100 as in the 3DCrafter Material Palette.
Sets the translucent factor.
Syntax
shape.SetTranslucent(Translucent As Variant)
Remarks
May be from 0 to 100 as in the 3DCrafter Material Palette.
Gets the diffuse factor.
Syntax
shape.GetDiffuse() As Variant
Remarks
May be from 0 to 100 as in the 3DCrafter Material Palette.
Sets the diffuse factor.
Syntax
shape.SetDiffuse(Diffuse As Variant)
Remarks
May be from 0 to 100 as in the 3DCrafter Material Palette.
Gets the ambient factor.
Syntax
shape.GetAmbient() As Variant
Remarks
May be from 0 to 100 as in the 3DCrafter Material Palette.
Sets the ambient factor.
Syntax
shape.SetAmbient(Ambient As Variant)
Remarks
May be from 0 to 100 as in the 3DCrafter Material Palette.
Gets the Specular factor.
Syntax
shape.GetSpecular() As Variant
Remarks
May be from 0 to 100 as in the 3DCrafter Material Palette.
Sets the Specular factor.
Syntax
shape.SetSpecular(Specular As Variant)
Remarks
May be from 0 to 100 as in the 3DCrafter Material Palette.
Gets the texture file name.
Syntax
shape.GetTextureFileName() As Variant
Sets the texture file name.
Syntax
shape.SetTextureFileName(FileName As Variant)
Gets the secondary texture file name.
Syntax
shape.GetSecondaryTextureFileName() As Variant
Sets the secondary texture file name.
Syntax
shape.SetSecondaryTextureFileName(FileName As Variant)
GetSecondaryTextureTranslucent
Gets the secondary texture translucent factor.
Syntax
shape.GetSecondaryTextureTranslucent() As Variant
Remarks
May be from 0 to 100 as in the 3DCrafter Material Palette.
SetSecondaryTextureTranslucent
Sets the secondary texture translucent factor.
Syntax
shape.SetSecondaryTextureTranslucent(Translucent As Variant)
Remarks
May be from 0 to 100 as in the 3DCrafter Material Palette.
Gets the translucent map file name.
Syntax
shape.GetTranslucentMapFileName() As Variant
Sets the translucent map file name.
Syntax
shape.SetTranslucentMapFileName(FileName As Variant)
Gets the bumpmap file name.
Syntax
shape.GetBumpMapFileName() As Variant
Sets the bumpmap file name.
Syntax
shape.SetBumpMapFileName(FileName As Variant)
Gets the specular map file name.
Syntax
shape.GetSpecularMapFileName() As Variant
Sets the specular file name.
Syntax
shape.SetSpecularMapFileName(FileName As Variant)
Gets the environment map file name.
Syntax
shape.GetEnvironmentMapFileName() As Variant
Sets the environment map file name.
Syntax
shape.SetEnvironmentMapFileName(FileName As Variant)
Gets the texture wrapping flags of the material.
Syntax
shape.GetTextureWrappingFlags(U As Variant,
V As Variant)
Sets the texture wrapping flags of the material
Syntax
shape.SetTextureWrappingFlags(U As Variant,
V As Variant)
Remarks
Flat wraps require 0, 0 as arguments.
Cylindrical wraps require 1, 0 as arguments.
Spherical wraps require 1, 1 as arguments.
Gets the value of a custom field.
Syntax
shape.GetCustomFieldValue(FieldID as Variant) As Variant
Remarks
The FieldID can be determined using GetMaterialCustomFieldID of the CSScene shape.
Sets the value of a custom field.
Syntax
shape.SetCustomFieldValue(FieldID as Variant, FieldValue As Variant)
Remarks
The FieldID can be determined using GetMaterialCustomFieldID of the CSScene shape.
Get how the alpha channel of the primary texture is used.
Syntax
shape.GetTextureAlphaChannelUse() As Variant
Remarks
0 = Standard Usage (as an alpha channel)
1 = Ignore Alpha Channel
2 = Use Alpha Channel as Bump Map
3 = Use Alpha Channel as Specular Map
4 = Use Alpha Channel as Environment Map
Used to indicate how the alpha channel of the primary texture is to be used.
Syntax
shape.SetTextureAlphaChannelUse(AlphaChannelUse as Variant)
Remarks
0 = Standard Usage (as an alpha channel)
1 = Ignore Alpha Channel
2 = Use Alpha Channel as Bump Map
3 = Use Alpha Channel as Specular Map
4 = Use Alpha Channel as Environment Map
Get whether any level of texture alpha channel translucency is to be treated as transparent.
Syntax
shape.GetTextureAlphaIsTransparent() As Variant
Remarks
0 = Use standard alpha channel translucency
1 = Alpha channel is to be treated as transparency
Used to indicate if any level of texture alpha channel translucency is to be treated as transparent.
Syntax
shape.SetTextureAlphaIsTransparent(AlphaIsTransparent As Variant)
Remarks
0 = Use standard alpha channel translucency
1 = Alpha channel is to be treated as transparency
Get Direct3D's D3DRS_ALPHAFUNC render state for this material.
Syntax
shape.GetAlphaTest() As Variant
Remarks
See Direct3D's D3DRS_ALPHAFUNC render state, and CONST_D3DCMPFUNC for more details.
Used to set Direct3D's D3DRS_ALPHAFUNC render state for this material.
Syntax
shape.SetAlphaTest(AlphaTest as Variant)
Remarks
See Direct3D's D3DRS_ALPHAFUNC render state, and CONST_D3DCMPFUNC for more details.
Get Direct3D's D3DRS_ALPHAREF render state for this material.
Syntax
shape.GetAlphaTestReference() As Variant
Remarks
See Direct3D's D3DRS_ALPHAREF render state.
Used to set Direct3D's D3DRS_ALPHAREF render state for this material.
Syntax
shape.SetAlphaTestReference(AlphaTestReference as Variant)
Remarks
See Direct3D's D3DRS_ALPHAREF render state.
Get whether this material is rendered double-sided or not.
Syntax
shape.GetDoubleSided() As Variant
Remarks
False = Render Single-Sided
True = Render Double-Sided
Set whether this material is to be rendered double-sided or not.
Syntax
shape.SetDoubleSided(DoubleSided as Variant)
Remarks
False = Render Single-Sided
True = Render Double-Sided