Jumpvalley.Animation.AnimatedNodeGroup Class Reference

Class that groups multiple AnimatedNodes together so that they can communicate with each other.

This class can also help make it so only one AnimatedNode within the group can be shown at a time. More...

Inheritance diagram for Jumpvalley.Animation.AnimatedNodeGroup:

Public Member Functions
	AnimatedNodeGroup ()
	Constructs a new instance of AnimatedNodeGroup
void	Remove (string id)
	Removes the AnimatedNode from the group that corresponds to the string identifier as specified in the id parameter.
void	ClearNodeList ()
	Removes all of the AnimatedNodes within NodeList, disconnecting this AnimatedNodeGroup's visibility toggle handler from the AnimatedNodes.
void	Add (string id, AnimatedNode node)
	Adds an AnimatedNode to this AnimatedNodeGroup.
bool	IsNodeVisible (string id)
	Returns whether or not the node in the group assigned to the specified string identifier (ID) is visible.
void	Hide (string id)
	Hides one of the AnimatedNodes in NodeList.
void	HideAll ()
	Hides all of the AnimatedNodes that have been made visible by this instance of AnimatedNodeGroup.
void	Show (string id)
	Shows one of the AnimatedNodes in NodeList.
void	Dispose ()

Protected Member Functions
void	RaiseCurrentlyVisibleNodeChanged ()

Properties
AnimatedNode	CurrentlyVisibleNode [get]
	The node within the AnimatedNodes list that's currently visible. This is set to null if CanOnlyShowOneNode is set to false.
Dictionary< string, AnimatedNode >	NodeList [get]
	The nodes within the group. In this dictionary, the keys are strings which are IDs that can be assigned to an AnimatedNode within the group. The corresponding value is the AnimatedNode associated with the ID.
bool	CanOnlyShowOneNode [get, set]
	Whether or not only one node within the group can be shown at a time.

Events
EventHandler	CurrentlyVisibleNodeChanged
	Event raised when the value of CurrentlyVisibleNode changes.

Detailed Description

Class that groups multiple AnimatedNodes together so that they can communicate with each other.

This class can also help make it so only one AnimatedNode within the group can be shown at a time.

Member Function Documentation

Add()

void Jumpvalley.Animation.AnimatedNodeGroup.Add ( string id, AnimatedNode node )

inline

Adds an AnimatedNode to this AnimatedNodeGroup.

Parameters

id	The string identifier to assign to the AnimatedNode
node	The AnimatedNode to add

Hide()

void Jumpvalley.Animation.AnimatedNodeGroup.Hide ( string id )

inline

Hides one of the AnimatedNodes in NodeList.

Parameters

id	The string identifier of the animated node to hide

IsNodeVisible()

bool Jumpvalley.Animation.AnimatedNodeGroup.IsNodeVisible ( string id )

inline

Returns whether or not the node in the group assigned to the specified string identifier (ID) is visible.

Parameters

id	The string identifier of the node

Returns

Whether or not the node is visible

Remove()

void Jumpvalley.Animation.AnimatedNodeGroup.Remove ( string id )

inline

Removes the AnimatedNode from the group that corresponds to the string identifier as specified in the id parameter.

Parameters

id	The string identifier of the AnimatedNode to remove

Show()

void Jumpvalley.Animation.AnimatedNodeGroup.Show ( string id )

inline

Shows one of the AnimatedNodes in NodeList.

Parameters

id	The string identifier of the animated node to show

---

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

• AnimatedNodeGroup.cs