KudanAR - Android  1.6.0
ARAlphaVideoNode Class Reference

Inherits ARMeshNode.

Public Member Functions

ARVideoTexture getVideoTexture ()
 
void setVideoTexture (ARVideoTexture videoTexture)
 
 ARAlphaVideoNode (ARVideoTexture videoTexture)
 
 ARAlphaVideoNode ()
 
void initWithPackagedFile (String asset)
 
void initFromPath (String filePath)
 
- Public Member Functions inherited from ARMeshNode
 ARMeshNode ()
 
Vector3f getCaptureColour ()
 
ARMesh getMesh ()
 
void setMesh (ARMesh mesh)
 
ARMaterial getMaterial ()
 
void setMaterial (ARMaterial material)
 
void render ()
 
Vector3f getLightDirection ()
 
void setLightDirection (Vector3f mLightVector)
 
- Public Member Functions inherited from ARNode
 ARNode ()
 
 ARNode (String name)
 
void remove ()
 
void removeAllChildren ()
 
void addChild (ARNode child)
 
ARNode getParent ()
 
void setParent (ARNode parent)
 
List< ARNodegetChildren ()
 
ARNode getWorld ()
 
Vector3f getPosition ()
 
void setPosition (Vector3f position)
 
void setPosition (float x, float y, float z)
 
void translateBy (float x, float y, float z)
 
void scaleBy (float x, float y, float z)
 
Vector3f getScale ()
 
void setScale (Vector3f scale)
 
void setScale (float x, float y, float z)
 
void scaleByUniform (float scale)
 
Quaternion getOrientation ()
 
void setOrientation (Quaternion orientation)
 
void setOrientation (float x, float y, float z, float w)
 
void rotateByQuaternion (Quaternion quaternion)
 
void rotateByDegrees (float angle, float x, float y, float z)
 
Matrix4f getFullTransform ()
 
Vector3f getFullScale ()
 
Quaternion getFullOrientation ()
 
Matrix4f getLocalTransform ()
 
Matrix4f getWorldTransform ()
 
boolean getVisible ()
 
void setVisible (boolean visible)
 
Quaternion getWorldOrientation ()
 
Vector3f getWorldScale ()
 
Vector3f getWorldPosition ()
 
Vector3f getFullPosition ()
 
String getName ()
 
void setName (String name)
 
void preRender ()
 
void postRender ()
 
ARNode findChildByName (String name)
 
void addChildren (List< ARNode > children)
 
void translateByVector (Vector3f translation)
 
void scaleByVector (Vector3f scale)
 
void rotateByRadians (float angle, float x, float y, float z)
 

Additional Inherited Members

- Protected Member Functions inherited from ARMeshNode
void glDraw ()
 

Detailed Description

An ARAlphaVideoNode is a subclass of ARMeshNode that renders a supplied alpha video file on a flat mesh in the scene. It can be initialised using either a video file bundled in your app or with an ARVideoTexture containing an alpha video. Alpha videos can be created using the Kudan AR Toolkit, which is available at https://www.kudan.eu/download-kudan-ar-sdk/.

Constructor & Destructor Documentation

◆ ARAlphaVideoNode() [1/2]

ARAlphaVideoNode.ARAlphaVideoNode ( ARVideoTexture  videoTexture)

Initialises an ARAlphaVideoNode using an ARVideoTexture.

Parameters
videoTextureThe ARVideoTexture to initialise the object with.

◆ ARAlphaVideoNode() [2/2]

ARAlphaVideoNode.ARAlphaVideoNode ( )

Initialises an empty ARAlphaVideoNode.

Member Function Documentation

◆ getVideoTexture()

ARVideoTexture ARAlphaVideoNode.getVideoTexture ( )

Returns the ARAlphaVideoNode's ARVideoTexture.

Returns
The video texture.

◆ initFromPath()

void ARAlphaVideoNode.initFromPath ( String  filePath)

Initialises an ARAlphaVideoNode with a string that loads an ARVideoTexture from its file path.

Example of use:

alphaVideoNode.initFromPath("/root/sdcard/Videos/example.mp4");

>

Parameters
filePathThe full filepath to your video file, including all folders and file extension.

◆ initWithPackagedFile()

void ARAlphaVideoNode.initWithPackagedFile ( String  asset)

Initialses an ARAlphaVideoNode with a string that loads an ARVideoTexture from an asset path.

Example of use:

alphaVideoNode.initWithPackagedFile("assets/example.mp4");
Parameters
assetThe filepath to your video asset, relative to the package.

◆ setVideoTexture()

void ARAlphaVideoNode.setVideoTexture ( ARVideoTexture  videoTexture)

Sets the ARVideoTexture used by the node.

Parameters
videoTexturethe ARVideoTexture to use.

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