Ogre::SceneManager - Ogre::SceneManager documentation

Ogre documentation Contained in the Ogre distribution.

Index

Code Index:

NAME

Top

Ogre::SceneManager

SYNOPSIS

Top

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

DESCRIPTION

Top

See the online API documentation athttp://www.ogre3d.org/docs/api/html/classOgre_1_1SceneManager.html

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

INSTANCE METHODS

Top

$obj->getName()

Returns

String

$obj->getTypeName()

Returns

String

$obj->createCamera($name)

Parameter types

$name : String

Returns

Camera *

$obj->getCamera($name)

Parameter types

$name : String

Returns

Camera *

$obj->hasCamera($name)

Parameter types

$name : String

Returns

bool

$obj->destroyCamera($name)

Parameter types

$name : String

Returns

void

$obj->destroyAllCameras()

Returns

void

$obj->createLight($name)

Parameter types

$name : String

Returns

Light *

$obj->getLight($name)

Parameter types

$name : String

Returns

Light *

$obj->hasLight($name)

Parameter types

$name : String

Returns

bool

$obj->destroyLight($name)

Parameter types

$name : String

Returns

void

$obj->destroyAllLights()

Returns

void

$obj->createSceneNode($name)

Parameter types

$name : String

Returns

SceneNode *

$obj->destroySceneNode($name)

Parameter types

$name : String

Returns

void

$obj->getRootSceneNode()

Returns

SceneNode *

$obj->getSceneNode($name)

Parameter types

$name : String

Returns

SceneNode *

$obj->hasSceneNode($name)

Parameter types

$name : String

Returns

bool

$obj->createEntity($entityName, $meshName)

Parameter types

$entityName : String
$meshName : String

Returns

Entity *

$obj->getEntity($name)

Parameter types

$name : String

Returns

Entity *

$obj->hasEntity($name)

Parameter types

$name : String

Returns

bool

$obj->destroyEntity($name)

Parameter types

$name : String

Returns

void

$obj->destroyAllEntities()

Returns

void

$obj->createManualObject($name)

Parameter types

$name : String

Returns

ManualObject *

$obj->getManualObject($name)

Parameter types

$name : String

Returns

ManualObject *

$obj->hasManualObject($name)

Parameter types

$name : String

Returns

bool

$obj->destroyManualObject($name)

Parameter types

$name : String

Returns

void

$obj->destroyAllManualObjects()

Returns

void

$obj->createBillboardChain($name)

Parameter types

$name : String

Returns

BillboardChain *

$obj->getBillboardChain($name)

Parameter types

$name : String

Returns

BillboardChain *

$obj->hasBillboardChain($name)

Parameter types

$name : String

Returns

bool

$obj->destroyBillboardChain($name)

Parameter types

$name : String

Returns

void

$obj->destroyAllBillboardChains()

Returns

void

$obj->createRibbonTrail($name)

Parameter types

$name : String

Returns

RibbonTrail *

$obj->getRibbonTrail($name)

Parameter types

$name : String

Returns

RibbonTrail *

$obj->hasRibbonTrail($name)

Parameter types

$name : String

Returns

bool

$obj->destroyRibbonTrail($name)

Parameter types

$name : String

Returns

void

$obj->destroyAllRibbonTrails()

Returns

void

$obj->createParticleSystem($name, $templateName)

Parameter types

$name : String
$templateName : String

Returns

ParticleSystem *

$obj->createAndAttachParticleSystem($name, $templateName, $node)

Parameter types

$name : String
$templateName : String
$node : SceneNode *

Returns

void

$obj->getParticleSystem($name)

Parameter types

$name : String

Returns

ParticleSystem *

$obj->hasParticleSystem($name)

Parameter types

$name : String

Returns

bool

$obj->destroyParticleSystem($name)

Parameter types

$name : String

Returns

void

$obj->destroyAllParticleSystems()

Returns

void

$obj->clearScene()

Returns

void

$obj->setAmbientLight($colour)

Parameter types

$colour : ColourValue *

Returns

void

$obj->setWorldGeometry($filename)

Parameter types

$filename : String

Returns

void

$obj->estimateWorldGeometry($filename)

Parameter types

$filename : String

Returns

size_t

$obj->hasOption($strKey)

Parameter types

$strKey : String

Returns

bool

$obj->setSkyPlane($enable, $plane, $materialName, $scale=1000, $tiling=10, $drawFirst=true, $bow=0, $xsegments=1, $ysegments=1, $groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)

Parameter types

$enable : bool
$plane : Plane *
$materialName : String
$scale=1000 : Real
$tiling=10 : Real
$drawFirst=true : bool
$bow=0 : Real
$xsegments=1 : int
$ysegments=1 : int
$groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME : String

Returns

void

$obj->isSkyPlaneEnabled()

Returns

bool

$obj->getSkyPlaneNode()

Returns

SceneNode *

$obj->setSkyBox($enable, $materialName, $distance=5000, $drawFirst=true, $orientation=&Quaternion::IDENTITY, $groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)

Parameter types

$enable : bool
$materialName : String
$distance=5000 : Real
$drawFirst=true : bool
$orientation=&Quaternion::IDENTITY : const Quaternion *
$groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME : String

Returns

void

$obj->isSkyBoxEnabled()

Returns

bool

$obj->getSkyBoxNode()

Returns

SceneNode *

$obj->setSkyDome($enable, $materialName, $curvature=10, $tiling=8, $distance=4000, $drawFirst=true, $orientation=&Quaternion::IDENTITY, $xsegments=16, $ysegments=16, $ysegments_keep=-1, $groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)

Parameter types

$enable : bool
$materialName : String
$curvature=10 : Real
$tiling=8 : Real
$distance=4000 : Real
$drawFirst=true : bool
$orientation=&Quaternion::IDENTITY : const Quaternion *
$xsegments=16 : int
$ysegments=16 : int
$ysegments_keep=-1 : int
$groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME : String

Returns

void

$obj->isSkyDomeEnabled()

Returns

bool

$obj->getSkyDomeNode()

Returns

SceneNode *

$obj->setFog($mode=FOG_NONE, $colour=&ColourValue::White, $expDensity=0.001, $linearStart=0.0, $linearEnd=1.0)

Parameter types

$mode=FOG_NONE : int
$colour=&ColourValue::White : const ColourValue *
$expDensity=0.001 : Real
$linearStart=0.0 : Real
$linearEnd=1.0 : Real

Returns

void

$obj->getFogMode()

Returns

int

$obj->getFogStart()

Returns

Real

$obj->getFogEnd()

Returns

Real

$obj->getFogDensity()

Returns

Real

$obj->createBillboardSet($name, $poolSize=20)

Parameter types

$name : String
$poolSize=20 : unsigned int

Returns

BillboardSet *

$obj->getBillboardSet($name)

Parameter types

$name : String

Returns

BillboardSet *

$obj->hasBillboardSet($name)

Parameter types

$name : String

Returns

bool

$obj->destroyBillboardSet($name)

Parameter types

$name : String

Returns

void

$obj->destroyAllBillboardSets()

Returns

void

$obj->setDisplaySceneNodes($display)

Parameter types

$display : bool

Returns

void

$obj->getDisplaySceneNodes()

Returns

bool

$obj->createAnimation($name, $length)

Parameter types

$name : String
$length : Real

Returns

Animation *

$obj->getAnimation($name)

Parameter types

$name : String

Returns

Animation *

$obj->hasAnimation($name)

Parameter types

$name : String

Returns

bool

$obj->destroyAnimation($name)

Parameter types

$name : String

Returns

void

$obj->destroyAllAnimations()

Returns

void

$obj->createAnimationState($name)

Parameter types

$name : String

Returns

AnimationState *

$obj->getAnimationState($name)

Parameter types

$name : String

Returns

AnimationState *

$obj->hasAnimationState($name)

Parameter types

$name : String

Returns

bool

$obj->destroyAnimationState($name)

Parameter types

$name : String

Returns

void

$obj->destroyAllAnimationStates()

Returns

void

$obj->manualRender($rend, $pass, $vp, $worldMatrix, $viewMatrix, $projMatrix, $doBeginEndFrame=false)

Parameter types

$rend : RenderOperation *
$pass : Pass *
$vp : Viewport *
$worldMatrix : const Matrix4 *
$viewMatrix : const Matrix4 *
$projMatrix : const Matrix4 *
$doBeginEndFrame=false : bool

Returns

void

$obj->getRenderQueue()

Returns

RenderQueue *

$obj->addSpecialCaseRenderQueue($uint8 qid)

Parameter types

$uint8 qid : (no info available)

Returns

void

$obj->removeSpecialCaseRenderQueue($uint8 qid)

Parameter types

$uint8 qid : (no info available)

Returns

void

$obj->clearSpecialCaseRenderQueues()

Returns

void

$obj->setSpecialCaseRenderQueueMode($int mode)

Parameter types

$int mode : (no info available)

Returns

void

$obj->getSpecialCaseRenderQueueMode()

Returns

int

$obj->isRenderQueueToBeProcessed($uint8 qid)

Parameter types

$uint8 qid : (no info available)

Returns

bool

$obj->setWorldGeometryRenderQueue($uint8 qid)

Parameter types

$uint8 qid : (no info available)

Returns

void

$obj->getWorldGeometryRenderQueue()

Returns

uint8

$obj->showBoundingBoxes($bShow)

Parameter types

$bShow : bool

Returns

void

$obj->getShowBoundingBoxes()

Returns

bool

$obj->createAABBQuery($box, $mask=0xFFFFFFFF)

Parameter types

$box : AxisAlignedBox *
$mask=0xFFFFFFFF : unsigned long

Returns

AxisAlignedBoxSceneQuery *

$obj->createSphereQuery($sphere, $mask=0xFFFFFFFF)

Parameter types

$sphere : Sphere *
$mask=0xFFFFFFFF : unsigned long

Returns

SphereSceneQuery *

$obj->createRayQuery($ray, $mask=0xFFFFFFFF)

Parameter types

$ray : Ray *
$mask=0xFFFFFFFF : unsigned long

Returns

RaySceneQuery *

$obj->createIntersectionQuery($unsigned long mask=0xFFFFFFFF)

Parameter types

$unsigned long mask=0xFFFFFFFF : (no info available)

Returns

IntersectionSceneQuery *

$obj->destroyQuery($query)

Parameter types

$query : SceneQuery *

Returns

void

$obj->setShadowTechnique($technique)

Parameter types

$technique : int

Returns

void

$obj->getShadowTechnique()

Returns

int

$obj->setShowDebugShadows($debug)

Parameter types

$debug : bool

Returns

void

$obj->getShowDebugShadows()

Returns

bool

$obj->setShadowColour($colour)

Parameter types

$colour : ColourValue *

Returns

void

$obj->setShadowDirectionalLightExtrusionDistance($dist)

Parameter types

$dist : Real

Returns

void

$obj->getShadowDirectionalLightExtrusionDistance()

Returns

Real

$obj->setShadowFarDistance($distance)

Parameter types

$distance : Real

Returns

void

$obj->getShadowFarDistance()

Returns

Real

$obj->setShadowIndexBufferSize($size)

Parameter types

$size : size_t

Returns

void

$obj->getShadowIndexBufferSize()

Returns

size_t

$obj->setShadowTextureSize($size)

Parameter types

$size : unsigned short

Returns

void

$obj->setShadowTextureConfig($size_t shadowIndex, $unsigned short width, $unsigned short height, $int format)

Parameter types

$size_t shadowIndex : (no info available)
$unsigned short width : (no info available)
$unsigned short height : (no info available)
$int format : (no info available)

Returns

void

$obj->setShadowTexturePixelFormat($int fmt)

Parameter types

$int fmt : (no info available)

Returns

void

$obj->setShadowTextureCount($size_t count)

Parameter types

$size_t count : (no info available)

Returns

void

$obj->getShadowTextureCount()

Returns

size_t

$obj->setShadowTextureSettings($unsigned short size, $unsigned short count, $int fmt=PF_X8R8G8B8)

Parameter types

$unsigned short size : (no info available)
$unsigned short count : (no info available)
$int fmt=PF_X8R8G8B8 : (no info available)

Returns

void

$obj->setShadowDirLightTextureOffset($Real offset)

Parameter types

$Real offset : (no info available)

Returns

void

$obj->getShadowDirLightTextureOffset()

Returns

Real

$obj->setShadowTextureFadeStart($Real fadeStart)

Parameter types

$Real fadeStart : (no info available)

Returns

void

$obj->setShadowTextureFadeEnd($Real fadeEnd)

Parameter types

$Real fadeEnd : (no info available)

Returns

void

$obj->setShadowTextureSelfShadow($bool selfShadow)

Parameter types

$bool selfShadow : (no info available)

Returns

void

$obj->getShadowTextureSelfShadow()

Returns

bool

$obj->setShadowTextureCasterMaterial($name)

Parameter types

$name : String

Returns

void

$obj->setShadowTextureReceiverMaterial($name)

Parameter types

$name : String

Returns

void

$obj->setShadowCasterRenderBackFaces($bool bf)

Parameter types

$bool bf : (no info available)

Returns

void

$obj->getShadowCasterRenderBackFaces()

Returns

bool

$obj->setShadowUseInfiniteFarPlane($bool enable)

Parameter types

$bool enable : (no info available)

Returns

void

$obj->isShadowTechniqueStencilBased()

Returns

bool

$obj->isShadowTechniqueTextureBased()

Returns

bool

$obj->isShadowTechniqueModulative()

Returns

bool

$obj->isShadowTechniqueAdditive()

Returns

bool

$obj->isShadowTechniqueIntegrated()

Returns

bool

$obj->isShadowTechniqueInUse()

Returns

bool

$obj->createStaticGeometry($name)

Parameter types

$name : String

Returns

StaticGeometry *

$obj->getStaticGeometry($name)

Parameter types

$name : String

Returns

StaticGeometry *

$obj->hasStaticGeometry($name)

Parameter types

$name : String

Returns

bool

$obj->destroyStaticGeometry($name)

Parameter types

$name : String

Returns

void

$obj->destroyAllStaticGeometry()

Returns

void

$obj->createInstancedGeometry($name)

Parameter types

$name : String

Returns

InstancedGeometry *

$obj->getInstancedGeometry($name)

Parameter types

$name : String

Returns

InstancedGeometry *

$obj->destroyInstancedGeometry($name)

Parameter types

$name : String

Returns

void

$obj->destroyAllInstancedGeometry()

Returns

void

$obj->createMovableObject($name, $typeName)

Parameter types

$name : String
$typeName : String

Returns

MovableObject *

$obj->destroyMovableObject($name, $typeName)

Parameter types

$name : String
$typeName : String

Returns

void

$obj->destroyAllMovableObjectsByType($typeName)

Parameter types

$typeName : String

Returns

void

$obj->destroyAllMovableObjects()

Returns

void

$obj->getMovableObject($name, $typeName)

Parameter types

$name : String
$typeName : String

Returns

MovableObject *

$obj->hasMovableObject($name, $typeName)

Parameter types

$name : String
$typeName : String

Returns

bool

$obj->injectMovableObject($m)

Parameter types

$m : MovableObject *

Returns

void

$obj->extractMovableObject($name, $typeName)

Parameter types

$name : String
$typeName : String

Returns

void

$obj->extractAllMovableObjectsByType($typeName)

Parameter types

$typeName : String

Returns

void

$obj->setVisibilityMask($uint32 vmask)

Parameter types

$uint32 vmask : (no info available)

Returns

void

$obj->getVisibilityMask()

Returns

uint32

$obj->setFindVisibleObjects($bool find)

Parameter types

$bool find : (no info available)

Returns

void

$obj->getFindVisibleObjects()

Returns

bool

$obj->getDestinationRenderSystem()

Returns

RenderSystem *

$obj->getCurrentViewport()

Returns

Viewport *

AUTHOR

Top

Scott Lanning <slanning@cpan.org>

For licensing information, see README.txt .

Ogre documentation Contained in the Ogre distribution. 
package Ogre::SceneManager;

use strict;
use warnings;


########## GENERATED CONSTANTS BEGIN
require Exporter;
unshift @Ogre::SceneManager::ISA, 'Exporter';

our %EXPORT_TAGS = (
	'IlluminationRenderStage' => [qw(
		IRS_NONE
		IRS_RENDER_TO_TEXTURE
		IRS_RENDER_RECEIVER_PASS
	)],
	'SpecialCaseRenderQueueMode' => [qw(
		SCRQM_INCLUDE
		SCRQM_EXCLUDE
	)],
	'PrefabType' => [qw(
		PT_PLANE
		PT_CUBE
		PT_SPHERE
	)],
);

$EXPORT_TAGS{'all'} = [ map { @{ $EXPORT_TAGS{$_} } } keys %EXPORT_TAGS ];
our @EXPORT_OK = @{ $EXPORT_TAGS{'all'} };
our @EXPORT = ();
########## GENERATED CONSTANTS END

1;

__END__