Unigine::Cigi::ICigiViewDef Class
| Header: | #include <CigiClientInterface.h> |
| Inherits: | ICigiHostPacket |
This class represents the CIGI View Definition packet interface.
Notice
CIGI plugin must be loaded.
ICigiViewDef Class
Members
int getViewID( )
Returns the view ID specified in the packet.Return value
View ID.int getGroupID( )
Returns the view group ID specified in the packet.Return value
View group ID.Notice
0 - means the view is not a member of any group.
int getNearEnabled( )
Returns the value of the Near Enable parameter specified in the packet.Return value
Near Enable parameter value: 1 - use the specified Near parameter to set the near clipping plane for the view; otherwise, 0.int getFarEnabled( )
Returns the value of the Far Enable parameter specified in the packet.Return value
Far Enable parameter value: 1 - use the specified Far parameter to set the far clipping plane for the view; otherwise, 0.int getLeftEnabled( )
Returns the value of the Left Enable parameter specified in the packet.Return value
Left Enable parameter value: 1 - use the specified Left parameter to set the left half-angle for the view; otherwise, 0.int getRightEnabled( )
Returns the value of the Right Enable parameter specified in the packet.Return value
Right Enable parameter value: 1 - use the specified Right parameter to set the right half-angle for the view; otherwise, 0.int getTopEnabled( )
Returns the value of the Top Enable parameter specified in the packet.Return value
Top Enable parameter value: 1 - use the specified Top parameter to set the top half-angle for the view; otherwise, 0.int getBottomEnabled( )
Returns the value of the Bottom Enable parameter specified in the packet.Return value
Bottom Enable parameter value: 1 - use the specified Bottom parameter to set the bottom half-angle for the view; otherwise, 0.int getMirrorMode( )
Returns the value of the Mirror Mode parameter specified in the packet.Return value
Mirror Mode parameter value. One of the MIRROR_* values.int getReplicationMode( )
Returns the value of the Replication Mode parameter specified in the packet.Return value
Replication Mode parameter value. One of the REPLICATION_* values.int getProjection( )
Returns the value of the Projection Type parameter specified in the packet.Return value
Projection Type parameter value. One of the PROJECTION_* values.int getViewType( )
Returns the value of the View Type parameter specified in the packet.Return value
View Type parameter value. IG-defined type for the view.int getReorder( )
Returns the value of the Reorder parameter specified in the packet.Return value
Reorder parameter value: 1 - the view will be moved to the top of any overlapping views; 0 - no reordering.Notice
In cases where multiple overlapping views are moved to the top, the last view specified shall have priority.
float getNear( )
Returns the distance to the near clipping plane specified in the packet.Return value
Near parameter value: distance to the near clipping plane, in units.float getFar( )
Returns the distance to the far clipping plane specified in the packet.Return value
Far parameter value: distance to the far clipping plane, in units.float getLeft( )
Returns the left half-angle for the view frustum specified in the packet.Return value
Left parameter value: left half-angle, in degrees.float getRight( )
Returns the right half-angle for the view frustum specified in the packet.Return value
Right parameter value: right half-angle, in degrees.float getTop( )
Returns the top half-angle for the view frustum specified in the packet.Return value
Top parameter value: top half-angle, in degrees.float getBottom( )
Returns the bottom half-angle for the view frustum specified in the packet.Return value
Bottom parameter value: bottom half-angle, in degrees.Last update:
2018-12-27
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)