KudanAR - Android  1.6.0
ARMaterial Class Reference

Inherited by ARAlphaVideoTextureMaterial, ARCameraBackgroundMaterial, ARCameraTextureMaterial, ARColourMaterial, ARLightMaterial, ARPointMaterial, ARTextureMaterial, and ARVideoTextureMaterial.

Public Member Functions

boolean getTransparent ()
 
void setTransparent (boolean transparent)
 
boolean getDepthOnly ()
 
void setDepthOnly (boolean depthOnly)
 
void setDepthWrite (boolean depthWrite)
 
boolean getDepthWrite ()
 
void setDepthTest (boolean depthTest)
 
boolean getDepthTest ()
 
boolean prepareRendererWithNode (ARNode node)
 
void setName (String name)
 
String getName ()
 

Detailed Description

A material represents how an object is shaded. This serves as a base class and shouldn't be used directly.

Member Function Documentation

◆ getDepthOnly()

boolean ARMaterial.getDepthOnly ( )

Whether the renderer draws the material to the depth buffer only.

Returns
boolean

◆ getDepthTest()

boolean ARMaterial.getDepthTest ( )

Returns whether pixels rendered with this material should be depth tested against existing pixels in the framebuffer. Default is true.

Returns
Whether pixels rendered with this material should be depth tested.

◆ getDepthWrite()

boolean ARMaterial.getDepthWrite ( )

Whether the renderer draws the material to the depth buffer only.

Returns
boolean

◆ getName()

String ARMaterial.getName ( )

Returns the name of the ARMaterial.

Returns
The ARMaterial's name.

◆ getTransparent()

boolean ARMaterial.getTransparent ( )

Returns whether or not this material uses alpha transparency. Default is false.

Returns
Whether this material uses transparency.

◆ prepareRendererWithNode()

boolean ARMaterial.prepareRendererWithNode ( ARNode  node)

Prepares renderer to draw ARMaterial. Sets whether the material has a transparency layer or should draw to the depth buffer only. This is handled automatically by the renderer and shouldn't be called directly.

Parameters
node
Returns

Reimplemented in ARLightMaterial, ARCameraBackgroundMaterial, ARTextureMaterial, ARAlphaVideoTextureMaterial, ARColourMaterial, ARVideoTextureMaterial, ARPointMaterial, and ARCameraTextureMaterial.

◆ setDepthOnly()

void ARMaterial.setDepthOnly ( boolean  depthOnly)

Sets whether the renderer draws the material to the depth buffer only.

Parameters
depthOnly

◆ setDepthTest()

void ARMaterial.setDepthTest ( boolean  depthTest)

Sets whether pixels rendered with this material should be depth tested against existing pixels in the framebuffer. Default: YES.

Parameters
depthTest

◆ setDepthWrite()

void ARMaterial.setDepthWrite ( boolean  depthWrite)

Sets whether the renderer writes the material to the depth buffer only.

Parameters
depthWrite

◆ setName()

void ARMaterial.setName ( String  name)

Sets the name of the ARMaterial.

Example of use: material.setName("example");

Parameters
nameThe name to assign to the material.

◆ setTransparent()

void ARMaterial.setTransparent ( boolean  transparent)

Sets whether the material is transparent.

Parameters
transparent

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