#include <interface.h>

Inheritance diagram for lwpp::InterfaceInfo:

Collaboration diagram for lwpp::InterfaceInfo:

Public Member Functions
	InterfaceInfo (void)
int	alertLevel (void)
	Returns the Alert Level specified on LightWave's Display Options.
int	autoKeyCreate ()
int	boxThreshold ()
	Returns the Bounding Box value on Layout Display options.
LWTime	currentTime (void)
	Returns the current time indicated by the frame slider on Layout.
unsigned int	displayFlags (void)
int	dynamicUpdate (void)
unsigned int	generalFlags (void)
	Returns the value of several general flags state.
void	getBonesDefaultColor (float color[3])
	Gets the default drawing color for Bones in viewports.
void	getCamerasDefaultColor (float color[3])
	Gets the default drawing color for Cameras in viewports.
void	getItemColour (LWItemID item, float rgba[4])
float	getItemIconScale (LWItemID item)
	Returns the icon scale of the Item in Layout's Viewports.
void	getLightsDefaultColor (float color[3])
	Gets the default drawing color for Lights in Viewports.
void	getObjectsDefaultColor (float color[3])
	Gets the default color for draw Objects on Layout's Viewports.
bool	isAutoKeyCreateAllChannels (void)
	Returns true if Auto Key Create is All Channels in Layout's General Preferences.
bool	isAutoKeyCreateModChannels (void)
	Returns true if Auto Key Create is Only Modificed Channels in Layout's General Preferences.
bool	isAutoKeyCreateOff (void)
	Returns true if Auto Key Create in Layout's General Preferences.
bool	isAutoKeyOn (void)
	Returns true if Auto Key is active on Layout Interface.
bool	isCagesDisplayed (void)
	Returns true if sub-patch cages are displayed on Layout's interface.
bool	isDynamicUpdateDelayed (void)
	Returns true if the Dynamic Update on Layout Display Options is delayed.
bool	isDynamicUpdateInteractive (void)
	Returns true if the Dynamic Update on Layout Display Options is interactive.
bool	isDynamicUpdateOff (void)
	Returns true if the Dynamic Update on Layout Display Options is off.
bool	isFieldChartDisplayed (void)
	Returns true if the Field Chart is displayed on Layout's Camera View.
bool	isFractionalFrames (void)
	Returns true if Fractional Frames is active.
bool	isHandlesDisplayed (void)
	Returns true if Handles are displayed on Layout's interface.
bool	isIKChainsDisplayed (void)
	Returns true if IK Chains are displayed on Layout's interface.
bool	isIKOn (void)
	Returns true if Inverse Kinematics is active on Layout Interface.
bool	isItemBBox (LWItemID item)
	Returns true if the item is showed as a Bounding Box on Layout's interface.
bool	isItemFrontFace (LWItemID item)
	Returns true if the item is showed as Front Face Wireframe on Layout's interface.
bool	isItemHidden (LWItemID item)
	Returns true if the item is hidden on Layout's interface.
bool	isItemShaded (LWItemID item)
	Returns true if the item is showed as Shaded on Layout's interface.
bool	isItemTextured (LWItemID item)
	Returns true if the item is showed as Textured on Layout's interface.
bool	isItemTexturedShaded (LWItemID item)
	Returns true if the item is showed as Textured Shaded on Layout's interface.
bool	isItemVertices (LWItemID item)
	Returns true if the item is showed as Vertices on Layout's interface.
bool	isItemWireframe (LWItemID item)
	Returns true if the item is showed as Wireframe on Layout's interface.
bool	isKeyFramesVisible (void)
	Returns true if Keys are visible on the timeline.
bool	isLMBSelectionOn (void)
	Returns true if Left button Item Select is active on Layout General Preferences.
bool	isMotionPathsDisplayed (void)
	Returns true if Motion Paths are displayed on Layout's interface.
bool	isParentInPlace (void)
	Returns true if Parent in Place is active.
bool	isPlayAtExactRate (void)
	Returns true if Play At Exact Rate is active on Layout General Preferences.
bool	isSafeAreasDisplayed (void)
	Returns true if Safe Areas are displayed on Layout's Camera View.
bool	isToolBarHidden (void)
	Returns true if the Tool Bar is hidden on Layout's Interface.
bool	isToolBarRight (void)
	Returns true if the Tool Bar is displayed on the right side of Layout's Interface.
int	itemColor (LWItemID item)
	Returns the index of the color used on Wireframe to draw the item in Layout Viewports.
unsigned int	itemFlags (LWItemID item)
	Returns the flags associated with the LWItemID.
int	itemVisibility (LWItemID item)
LWFrame	previewEnd (void)
	Returns the End Frame defined for previews on Layout Preview options.
LWFrame	previewStart (void)
	Returns the Start Frame defined for previews on Layout Preview options.
LWFrame	previewStep (void)
	Returns the Step Frame defined for previews on Layout Preview options.
Point3d	schematicPosition (LWItemID item)
lwpp::LWItem	selectedItem () const
	Returns the lwpp::LWItem of the selected Item in Layout, or the first selected item of a multiple selection.
std::vector< lwpp::LWItem >	selectedItems () const
	Returns a std::vector<lwpp::LWItem> with 1 or multiple elements depending the selected Items in Layout.
void	setBonesDefaultColor (float color[3])
	Changes the default color for Bones on Layout's Viewports.
void	setCamerasDefaultColor (float color[3])
	Changes the default color for Cameras on Layout's Viewports.
void	setItemColorCustom (LWItemID item, double *color)
	Changes the color to the item using 0.0 to 1.0 values for each R,G,B.
void	setItemColorIndex (LWItemID item, int color)
	Changes the color to the item to one of the indexed colors.
void	setLightsDefaultColor (float color)
	Changes the default color for Lights on Layout's Viewports.
void	setObjectsDefaultColor (float color)
	Changes the default color for draw objects on Layout's Viewports.
bool	showError (void)
	Returns true if the alert level is expert on LightWave's Display Options.
bool	showInfo (void)
	Returns true if the alert level is beginner on LightWave's Display Options.
bool	showWarning (void)
	Returns true if the alert level is intermediate on LightWave's Display Options.

Protected Member Functions
bool	_acquireGlobal ()
virtual bool	available () const
	Check if the global is available.
virtual LWInterfaceInfo *	getGlobal ()
	Get the pointer to the global.
LWInterfaceInfo *	operator-> ()
	Get the pointer to the global.

Static Protected Attributes
static LWInterfaceInfo *	globPtr
	Pointer to the global functions.

Detailed Description

Use this class to get several information about the state of LightWave's Layout Interface Usage: On your header declare a member lwpp::InterfaceInfo intInfo; Initialize it like this: (for example in the constructor of your plugin class) intInfo = lwpp::InterfaceInfo(); NOTE: InterfaceInfo need to be re-created EVERY time before it's used, to be sure it contains updated information about Lightwave's Interface

Constructor & Destructor Documentation

lwpp::InterfaceInfo::InterfaceInfo ( void )

inline

Member Function Documentation

bool lwpp::GlobalBase< LWInterfaceInfo >::_acquireGlobal ( )

inlineprotectedinherited

int lwpp::InterfaceInfo::alertLevel ( void )

inline

Returns the Alert Level specified on LightWave's Display Options.

int lwpp::InterfaceInfo::autoKeyCreate ( )

inline

Returns one of the three possible states of the Auto Create Key setting in Layout's General Preferences

virtual bool lwpp::GlobalBase< LWInterfaceInfo >::available ( ) const

inlinevirtualinherited

Check if the global is available.

int lwpp::InterfaceInfo::boxThreshold ( )

inline

Returns the Bounding Box value on Layout Display options.

LWTime lwpp::InterfaceInfo::currentTime ( void )

inline

Returns the current time indicated by the frame slider on Layout.

unsigned int lwpp::InterfaceInfo::displayFlags ( void )

inline

int lwpp::InterfaceInfo::dynamicUpdate ( void )

inline

Returns an int indicating one of the three posible states of Dynamic Update in Layout Display Options

unsigned int lwpp::InterfaceInfo::generalFlags ( void )

inline

Returns the value of several general flags state.

void lwpp::InterfaceInfo::getBonesDefaultColor ( float color[3] )

inline

Gets the default drawing color for Bones in viewports.

Parameters:

[out] color will contain the colour as a float RGB triplet

void lwpp::InterfaceInfo::getCamerasDefaultColor ( float color[3] )

inline

Gets the default drawing color for Cameras in viewports.

Parameters:

[out] color will contain the colour as a float RGB triplet

virtual LWInterfaceInfo * lwpp::GlobalBase< LWInterfaceInfo >::getGlobal ( )

inlinevirtualinherited

Get the pointer to the global.

void lwpp::InterfaceInfo::getItemColour	(	LWItemID	item,
		float	rgba[4]
	)

inline

float lwpp::InterfaceInfo::getItemIconScale ( LWItemID item )

inline

Returns the icon scale of the Item in Layout's Viewports.

It's used to size the icon of the item on them.

void lwpp::InterfaceInfo::getLightsDefaultColor ( float color[3] )

inline

Gets the default drawing color for Lights in Viewports.

Parameters:

[out] color will contain the colour as a float RGB triplet

void lwpp::InterfaceInfo::getObjectsDefaultColor ( float color[3] )

inline

Gets the default color for draw Objects on Layout's Viewports.

Parameters:

[out] color will contain the colour as a float RGB triplet

bool lwpp::InterfaceInfo::isAutoKeyCreateAllChannels ( void )

inline

Returns true if Auto Key Create is All Channels in Layout's General Preferences.

bool lwpp::InterfaceInfo::isAutoKeyCreateModChannels ( void )

inline

Returns true if Auto Key Create is Only Modificed Channels in Layout's General Preferences.

bool lwpp::InterfaceInfo::isAutoKeyCreateOff ( void )

inline

Returns true if Auto Key Create in Layout's General Preferences.

bool lwpp::InterfaceInfo::isAutoKeyOn ( void )

inline

Returns true if Auto Key is active on Layout Interface.

bool lwpp::InterfaceInfo::isCagesDisplayed ( void )

inline

Returns true if sub-patch cages are displayed on Layout's interface.

bool lwpp::InterfaceInfo::isDynamicUpdateDelayed ( void )

inline

Returns true if the Dynamic Update on Layout Display Options is delayed.

bool lwpp::InterfaceInfo::isDynamicUpdateInteractive ( void )

inline

Returns true if the Dynamic Update on Layout Display Options is interactive.

bool lwpp::InterfaceInfo::isDynamicUpdateOff ( void )

inline

Returns true if the Dynamic Update on Layout Display Options is off.

bool lwpp::InterfaceInfo::isFieldChartDisplayed ( void )

inline

Returns true if the Field Chart is displayed on Layout's Camera View.

bool lwpp::InterfaceInfo::isFractionalFrames ( void )

inline

Returns true if Fractional Frames is active.

bool lwpp::InterfaceInfo::isHandlesDisplayed ( void )

inline

Returns true if Handles are displayed on Layout's interface.

bool lwpp::InterfaceInfo::isIKChainsDisplayed ( void )

inline

Returns true if IK Chains are displayed on Layout's interface.

bool lwpp::InterfaceInfo::isIKOn ( void )

inline

Returns true if Inverse Kinematics is active on Layout Interface.

bool lwpp::InterfaceInfo::isItemBBox ( LWItemID item )

inline

Returns true if the item is showed as a Bounding Box on Layout's interface.

bool lwpp::InterfaceInfo::isItemFrontFace ( LWItemID item )

inline

Returns true if the item is showed as Front Face Wireframe on Layout's interface.

bool lwpp::InterfaceInfo::isItemHidden ( LWItemID item )

inline

Returns true if the item is hidden on Layout's interface.

bool lwpp::InterfaceInfo::isItemShaded ( LWItemID item )

inline

Returns true if the item is showed as Shaded on Layout's interface.

bool lwpp::InterfaceInfo::isItemTextured ( LWItemID item )

inline

Returns true if the item is showed as Textured on Layout's interface.

bool lwpp::InterfaceInfo::isItemTexturedShaded ( LWItemID item )

inline

Returns true if the item is showed as Textured Shaded on Layout's interface.

bool lwpp::InterfaceInfo::isItemVertices ( LWItemID item )

inline

Returns true if the item is showed as Vertices on Layout's interface.

bool lwpp::InterfaceInfo::isItemWireframe ( LWItemID item )

inline

Returns true if the item is showed as Wireframe on Layout's interface.

bool lwpp::InterfaceInfo::isKeyFramesVisible ( void )

inline

Returns true if Keys are visible on the timeline.

bool lwpp::InterfaceInfo::isLMBSelectionOn ( void )

inline

Returns true if Left button Item Select is active on Layout General Preferences.

bool lwpp::InterfaceInfo::isMotionPathsDisplayed ( void )

inline

Returns true if Motion Paths are displayed on Layout's interface.

bool lwpp::InterfaceInfo::isParentInPlace ( void )

inline

Returns true if Parent in Place is active.

bool lwpp::InterfaceInfo::isPlayAtExactRate ( void )

inline

Returns true if Play At Exact Rate is active on Layout General Preferences.

bool lwpp::InterfaceInfo::isSafeAreasDisplayed ( void )

inline

Returns true if Safe Areas are displayed on Layout's Camera View.

bool lwpp::InterfaceInfo::isToolBarHidden ( void )

inline

Returns true if the Tool Bar is hidden on Layout's Interface.

bool lwpp::InterfaceInfo::isToolBarRight ( void )

inline

Returns true if the Tool Bar is displayed on the right side of Layout's Interface.

int lwpp::InterfaceInfo::itemColor ( LWItemID item )

inline

Returns the index of the color used on Wireframe to draw the item in Layout Viewports.

unsigned int lwpp::InterfaceInfo::itemFlags ( LWItemID item )

inline

Returns the flags associated with the LWItemID.

int lwpp::InterfaceInfo::itemVisibility ( LWItemID item )

inline

Retirns an int indicating one of the eight possible shading states of an Item

LWInterfaceInfo * lwpp::GlobalBase< LWInterfaceInfo >::operator-> ( )

inlineinherited

Get the pointer to the global.

LWFrame lwpp::InterfaceInfo::previewEnd ( void )

inline

Returns the End Frame defined for previews on Layout Preview options.

LWFrame lwpp::InterfaceInfo::previewStart ( void )

inline

Returns the Start Frame defined for previews on Layout Preview options.

LWFrame lwpp::InterfaceInfo::previewStep ( void )

inline

Returns the Step Frame defined for previews on Layout Preview options.

Point3d lwpp::InterfaceInfo::schematicPosition ( LWItemID item )

inline

Returns a lwpp::Point3d with it's x and y members indicating it's position inside the Schematic View

lwpp::LWItem lwpp::InterfaceInfo::selectedItem ( void ) const

Returns the lwpp::LWItem of the selected Item in Layout, or the first selected item of a multiple selection.

std::vector< lwpp::LWItem > lwpp::InterfaceInfo::selectedItems ( ) const

Returns a std::vector<lwpp::LWItem> with 1 or multiple elements depending the selected Items in Layout.

void lwpp::InterfaceInfo::setBonesDefaultColor ( float color[3] )

inline

Changes the default color for Bones on Layout's Viewports.

Parameters:

[out] color will contain the colour as a float RGB triplet

void lwpp::InterfaceInfo::setCamerasDefaultColor ( float color[3] )

inline

Changes the default color for Cameras on Layout's Viewports.

Parameters:

[out] color will contain the colour as a float RGB triplet

void lwpp::InterfaceInfo::setItemColorCustom	(	LWItemID	item,
		double *	color
	)

inline

Changes the color to the item using 0.0 to 1.0 values for each R,G,B.

Parameters:

[in]	item	the itemid of the item to change
[in]	color	the new colour as a float RGB triplet

void lwpp::InterfaceInfo::setItemColorIndex	(	LWItemID	item,
		int	color
	)

inline

Changes the color to the item to one of the indexed colors.

Parameters:

[in]	item	the itemid of the item to change
[in]	color	the new colour as an index or a a 24bit color if you set the upper byte of a 32bit color to 0x01. I.e. Red will be 0x01FF0000

void lwpp::InterfaceInfo::setLightsDefaultColor ( float color )

inline

Changes the default color for Lights on Layout's Viewports.

Parameters:

[out] color will contain the colour as a float RGB triplet

void lwpp::InterfaceInfo::setObjectsDefaultColor ( float color )

inline

Changes the default color for draw objects on Layout's Viewports.

Parameters:

[out] color will contain the colour as a float RGB triplet

bool lwpp::InterfaceInfo::showError ( void )

inline

Returns true if the alert level is expert on LightWave's Display Options.

bool lwpp::InterfaceInfo::showInfo ( void )

inline

Returns true if the alert level is beginner on LightWave's Display Options.

bool lwpp::InterfaceInfo::showWarning ( void )

inline

Returns true if the alert level is intermediate on LightWave's Display Options.

Member Data Documentation

LWInterfaceInfo * lwpp::GlobalBase< LWInterfaceInfo >::globPtr

staticprotectedinherited

Pointer to the global functions.

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

Public Member Functions

Protected Member Functions

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation