Reference Page for vsFrameData

OpenGL Vizserver Reference Page

NAME

vsFrameData - Definition of frame information and data structure

INHERITS FROM

vsQueryTypeBaseCls : vsParamTypeCls : vsQueryTypeNameAccessorCls : vsCmprParamTypeCls

HEADER FILE

#include <vizserver/vsFrame.h>

PUBLIC METHOD SUMMARY

vsBool isQueryTypeSupported (

vsQueryTypes::Base name) const;

vsBool isParamTypeSupported (

vsParamTypes::Base) const;

inline vsCmprParamTypesQueryParams getParamName (

) const;

INHERITED PUBLIC METHODS

Inherited from vsCmprParamTypeCls

virtual ParamGroup getParamName (

) const;

Inherited from vsQueryTypeNameAccessorCls

virtual vsStatus getParam (

QueryTypeEnum name, vsParamTypeCls*& param) const;

virtual QueryClass getTypeName (

) const;

virtual vsBool isParamPresent (

QueryTypeEnum name) const;

Inherited from vsParamTypeCls

virtual vsBool isParamTypeSupported (

vsParamTypes::Base name) const;

Inherited from vsQueryTypeBaseCls

virtual vsBool isQueryTypeSupported (

vsQueryTypes::Base name) const;

CLASS DESCRIPTION

Images rendered by an application and transported to the client system are captured in frames. A frame consists of multiple fields, each field having a specific type. vsFrameData is the structure used to allow clients access to the field data that is present within the transported frames. The field data is stored as a vsFieldData object, which is embedded inside of the vsFrameData structure.

vsFrameData inherits from vsQueryTypeNameAccessorCls and vsCmprParamTypeCls and therefore is a query type container. In order to extract vsFieldData parameters from this object, the query type facilities defined by vsQueryTypeNameAccessorCls must be used.

Extracting Field Information

Extracting the vsFieldData objects contained inside of the vsFrameData objects is simple. Simple pass in the appropriate vsFieldTypes::Fields value as the first parameter to getParam() for the field needed. The second parameter would be a pointer to the vsFieldData type, down casted to vsParamTypeCls.

After the function call, if the status is vsErrNone, the pointer should refer to the field data object.

METHOD DESCRIPTIONS

getParamName()

inline vsCmprParamTypesQueryParams getParamName (

) const;

Returns the specific parameter name associated with this parameter. vsFrameData can return two different parameter names: vsCmprParamTypes::FrameData in circumstances where it is contained within a vsCmprInputQueryArg or vsCmprOutputQueryArg object, and vsCmprParamTypes::FrameDataParam in circumstances where it is contained within the more generic vsCmprParamArg object.

isParamTypeSupported()

vsBool isParamTypeSupported (

vsParamTypes::Base) const;

Returns TRUE if this object belongs to the parameter type family specified by vsParamTypes::Base argument. vsFrameData initially belongs to the vsParamTypes::CmprQueryParams family.

isQueryTypeSupported()

vsBool isQueryTypeSupported (

vsQueryTypes::Base name) const;

Returns TRUE is query type accessor interface name is supported by this object. Currently only the vsQueryTypes::NameAccessor is supported and vsQueryTypeNameAccessorCls is the only query type interface used.