GUI_SceneCameras Class Reference

Collection class for all cameras in a scene, from all sources. More...

#include <GUI_SceneCameras.h>

Classes
class	CameraInfo

Public Types
enum	SourceType {   GEO_PRIM, OBJ_NODE, USD_PRIM, COP_NODE,   DRAWABLE }
	Where the camera is generated from. More...
enum	LightType { LIGHT }
enum	TypeGT { DRAWABLE_CAMERA }
enum	ContextType { OBJ_SOP_CONTEXT, LOP_CONTEXT, COP_CONTEXT }
enum	DrawableBinding { DRAWABLE_INDEX = -1 }
	The binding that drawable cameras are registered with. More...

Public Member Functions
	GUI_SceneCameras ()
void	registerCameras (int look_id, const UT_StringMap< CameraInfo > &cameras)
	Register a number of cameras created by the given look. More...
void	removeCameras (int look_id)
	Remove cameras associated with a look. More...
bool	hasCameras (int look_id) const
void	getCameras (UT_Array< std::pair< UT_StringHolder, CameraInfo >> &cams, ContextType menu_type)
	Return a list of camera names for a given context. More...
void	getLights (UT_Array< std::pair< UT_StringHolder, CameraInfo >> &lights, ContextType menu_type)
	Return a list of light names to view through, for a given context. More...

Static Public Member Functions
static UT_StringHolder	getCameraName (ContextType for_context, const CameraInfo &camera)
static UT_StringHolder	getCameraName (const OP_Node *node_network, const CameraInfo &camera)

Protected Member Functions
	UT_NON_COPYABLE (GUI_SceneCameras)

Static Protected Member Functions
static UT_StringHolder	makeCameraName (SourceType cam_source, ContextType context, int op_id, UT_StringHolder cam_name=UT_StringHolder())
	Generate a name for a camera suitable for display. More...

Protected Attributes
UT_Map< int, UT_StringMap < CameraInfo > >	myCameras

Detailed Description

Collection class for all cameras in a scene, from all sources.

Definition at line 26 of file GUI_SceneCameras.h.

Member Enumeration Documentation

enum GUI_SceneCameras::ContextType

The context the camera is being shown for (not its source context). This can affect how the camera name is displayed

Enumerator
OBJ_SOP_CONTEXT
LOP_CONTEXT
COP_CONTEXT

Definition at line 37 of file GUI_SceneCameras.h.

enum GUI_SceneCameras::DrawableBinding

The binding that drawable cameras are registered with.

Enumerator
DRAWABLE_INDEX

Definition at line 40 of file GUI_SceneCameras.h.

enum GUI_SceneCameras::LightType

Enumerator
LIGHT

Definition at line 32 of file GUI_SceneCameras.h.

enum GUI_SceneCameras::SourceType

Where the camera is generated from.

Enumerator
GEO_PRIM
OBJ_NODE
USD_PRIM
COP_NODE
DRAWABLE

Definition at line 30 of file GUI_SceneCameras.h.

enum GUI_SceneCameras::TypeGT

Enumerator
DRAWABLE_CAMERA

Definition at line 33 of file GUI_SceneCameras.h.

Constructor & Destructor Documentation

GUI_SceneCameras::GUI_SceneCameras ( )

inline

Definition at line 105 of file GUI_SceneCameras.h.

Member Function Documentation

static UT_StringHolder GUI_SceneCameras::getCameraName ( ContextType  for_context, const CameraInfo &  camera  )

static

static UT_StringHolder GUI_SceneCameras::getCameraName ( const OP_Node *  node_network, const CameraInfo &  camera  )

static

void GUI_SceneCameras::getCameras	(	UT_Array< std::pair< UT_StringHolder, CameraInfo >> &	cams,
		ContextType	menu_type
	)

Return a list of camera names for a given context.

void GUI_SceneCameras::getLights	(	UT_Array< std::pair< UT_StringHolder, CameraInfo >> &	lights,
		ContextType	menu_type
	)

Return a list of light names to view through, for a given context.

bool GUI_SceneCameras::hasCameras ( int  look_id ) const

inline

Definition at line 113 of file GUI_SceneCameras.h.

static UT_StringHolder GUI_SceneCameras::makeCameraName ( SourceType  cam_source, ContextType  context, int  op_id, UT_StringHolder  cam_name = UT_StringHolder()  )

staticprotected

Generate a name for a camera suitable for display.

void GUI_SceneCameras::registerCameras	(	int	look_id,
		const UT_StringMap< CameraInfo > &	cameras
	)

Register a number of cameras created by the given look.

void GUI_SceneCameras::removeCameras

(

int

look_id

)

Remove cameras associated with a look.

GUI_SceneCameras::UT_NON_COPYABLE ( GUI_SceneCameras  )

protected

Member Data Documentation

UT_Map<int, UT_StringMap<CameraInfo> > GUI_SceneCameras::myCameras

protected

Definition at line 139 of file GUI_SceneCameras.h.

---

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

• GUI/GUI_SceneCameras.h