NAME

Ogre::OverlayElement

SYNOPSIS

  use Ogre;
  use Ogre::OverlayElement;
  # (for now see examples/README.txt)

DESCRIPTION

See the online API documentation at http://www.ogre3d.org/docs/api/html/classOgre_1_1OverlayElement.html

Note: this Perl binding is currently experimental and subject to API changes.

INSTANCE METHODS

$obj->initialise()

Returns

void

$obj->show()

Returns

void

$obj->hide()

Returns

void

$obj->getName()

Returns

String

$obj->isVisible()

Returns

bool

$obj->isEnabled()

Returns

bool

$obj->setEnabled($b)

Parameter types

$b : bool

Returns

void

$obj->setDimensions($width, $height)

Parameter types

$width : Real

$height : Real

Returns

void

$obj->setPosition($left, $top)

Parameter types

$left : Real

$top : Real

Returns

void

$obj->setWidth($width)

Parameter types

$width : Real

Returns

void

$obj->setHeight($height)

Parameter types

$height : Real

Returns

void

$obj->setLeft($left)

Parameter types

$left : Real

Returns

void

$obj->setTop($top)

Parameter types

$top : Real

Returns

void

$obj->getWidth()

Returns

Real

$obj->getHeight()

Returns

Real

$obj->getLeft()

Returns

Real

$obj->getTop()

Returns

Real

$obj->getMaterialName()

Returns

String

$obj->setMaterialName($matName)

Parameter types

$matName : String

Returns

void

$obj->getTypeName()

Returns

String

$obj->getCaption()

Returns

String

$obj->setCaption($text)

Parameter types

$text : String

Returns

void

$obj->setColour($col)

Parameter types

$col : ColourValue *

Returns

void

$obj->contains($x, $y)

Parameter types

$x : Real

$y : Real

Returns

bool

$obj->findElementAt($x, $y)

Parameter types

$x : Real

$y : Real

Returns

OverlayElement *

$obj->isContainer()

Returns

bool

$obj->isKeyEnabled()

Returns

bool

$obj->isCloneable()

Returns

bool

$obj->getParent()

Returns

OverlayContainer *

$obj->getZOrder()

Returns

unsigned short

$obj->getSquaredViewDepth($cam)

Parameter types

$cam : Camera *

Returns

Real

$obj->copyFromTemplate($templateOverlay)

Parameter types

$templateOverlay : OverlayElement *

Returns

void

$obj->clone($instanceName)

Parameter types

$instanceName : String

Returns

OverlayElement *

$obj->getSourceTemplate()

Returns

const OverlayElement *

AUTHOR

Scott Lanning <slanning@cpan.org>

For licensing information, see README.txt .

cpanm Ogre

perl -MCPAN -e shell
install Ogre