afxMooringData

consoledoc.h

A datablock that specifies a Mooring effect.

More...

Public Attributes

bool

Specifies whether to display an axis to help visualize the position and orientation of the mooring.

char

Specifies the networking model used for the mooring and should be one of:

bool

This field is only meaningful for networking settings of SCOPE_ALWAYS and GHOSTABLE. In these cases, client moorings are ghosting a mooring on the server, and trackPosOnly determines if the client moorings need to be updated with the server mooring's complete transform or just its position. If only the position needs to be tracked, setting trackPosOnly to true will reduce the network traffic.

Detailed Description

A datablock that specifies a Mooring effect.

A Mooring is an invisible effect object which can be positioned and oriented within a scene like other objects. Its main purpose is to serve as a common mount point for other effects within the same choreographer. Typically one uses AFX animation features to create movement for a Mooring and then other effects are bound to it using effect-to-effect constraints (#effect).

Public Attributes

bool displayAxisMarker 

Specifies whether to display an axis to help visualize the position and orientation of the mooring.

char networking 

Specifies the networking model used for the mooring and should be one of:

$AFX::SCOPE_ALWAYS, $AFX::GHOSTABLE, $AFX::SERVER_ONLY, or $AFX::CLIENT_ONLY

bool trackPosOnly 

This field is only meaningful for networking settings of SCOPE_ALWAYS and GHOSTABLE. In these cases, client moorings are ghosting a mooring on the server, and trackPosOnly determines if the client moorings need to be updated with the server mooring's complete transform or just its position. If only the position needs to be tracked, setting trackPosOnly to true will reduce the network traffic.