Moray Plugin SDK Documentation
This release of the Plugin SDK can be used by Moray V3.5 (Build 9065) and later.

CSceneInterface CFilesInterface CMenuInterface CImportInterface
CExportInterface CObjectInterface CExternalInterface
CPluginDialog CPluginObject
CAttributes CProgressBar C support Compiler Settings

What's New

CAttributes

The CAttributes is a helper class that takes care of setting up a MRY_OBJ_ATTRIBUTES struct, including (if required) the object-specific (MRY_OBJ_SPECIFIC) and the texture-specific (MRY_TEXTURE_DATA) part.

Reference List of Functions

By Function Group Alphabetically
CAttributes
Init
InitAttributes
InitObjectSpecific
UseObjectSpecific
InitLayerInfo
UseLayerInfo
GetAttributes
GetObjectSpecific
GetTextureSpecific
GetLayerInfo
Attribs
TextureSpecific
ObjSpecific
LayerInfo
LPMRY_OBJ_ATTRIBUTES
Attribs
CAttributes
GetAttributes
GetLayerInfo
GetObjectSpecific
GetTextureSpecific
Init
InitAttributes
InitLayerInfo
InitObjectSpecific
LPMRY_OBJ_ATTRIBUTES
LayerInfo
ObjSpecific
TextureSpecific
UseLayerInfo
UseObjectSpecific



 

CAttributes

The function CAttributes is the constructor for the class.

    CAttributes(bool bUseObjSpecific=false, bool bUseLayerInfo=false);

Parameters

bUseObjSpecific

Determines whether to use the object-specific data.

bUseLayerInfo

NEW!Determines whether to use the layer info data.

Remarks

The attribute struct is initialized.
If bUseObjSpecific is true then an object-specific and a texture-specific struct are initialized and connected to the attribute struct.
If bUseLayerInfo is true then an layer info struct are initialized and connected to the attribute struct.


Top
 

Init

The function Init initializes all the members of the attribute struct.

    void Init(bool bUseObjSpecific=false, bool bUseLayerInfo=false);

Parameters

bUseObjSpecific

Determines whether to use the object-specific data.

bUseLayerInfo

NEW!Determines whether to use the layer info data.

Remarks

If bUseObjSpecific is true the a object-specific and a texture-specific struct is connected to the attribute struct and are initialized.
If bUseLayerInfo is true the a layer info struct is connected to the attribute struct and initialized.


Top
 

InitAttributes

The function InitAttributes initializes all the members of the attribute struct.

    void InitAttributes();

Remarks

This clears the contents of the attribute struct and initializes it. The object-specific and texture-specific structs are disconnected from the attributes struct.


Top
 

InitObjectSpecific

The function InitObjectSpecific initializes all the members of the object-specific and texture-specific member structs.

    void InitObjectSpecific();

Remarks

This clears the contents of the object-specific and texture-specific structs, but does not connect them to the attribute struct.


Top
 

UseObjectSpecific

The function UseObjectSpecific sets or resets the usage of the object-specific and texture-specific structs of the attribute struct.

    void UseObjectSpecific(bool bState);

Parameters

bState

Determines whether the object-specific and texture-specific structs should be used.

Remarks

The contents of the attribute, the object-specific and the texture-specific structs are not initialized.


Top
 

NEW!InitLayerInfo

The function InitLayerInfo initializes all the members of the layer info member structs.

    void InitLayerInfo();

Remarks

This clears the contents of the layer info structs, but does not connect them to the attribute struct.


Top
 

NEW!UseLayerInfo

The function UseLayerInfo sets or resets the usage of the layer info structs of the attribute struct.

    void UseLayerInfo(bool bState);

Parameters

bState

Determines whether the layer info structs should be used.

Remarks

The contents of the attribute and layer info structs are not initialized.


Top
 

GetAttributes

The function GetAttributes returns a pointer to the attribute struct.

    LPMRY_OBJ_ATTRIBUTES GetAttributes();

Return Values

A pointer to the MRY_OBJ_ATTRIBUTE struct.


Top
 

GetObjectSpecific

The function GetObjectSpecific returns a pointer to the object-specific struct.

    LPMRY_OBJ_SPECIFIC GetObjectSpecific();

Return Values

A pointer to the MRY_OBJ_SPECIFIC struct.


Top
 

GetTextureSpecific

The function GetTextureSpecific returns a pointer to the texture-specific struct.

    LPMRY_TEXTURE_DATA GetTextureSpecific();

Return Values

A pointer to the MRY_TEXTURE_DATA struct.


Top
 

NEW!GetLayerInfo

The function GetLayerInfo returns a pointer to the layer info struct.

    LPMRY_OBJ_LAYERS GetLayerInfo();

Return Values

A pointer to the MRY_OBJ_LAYERS struct.


Top
 

Attribs

The function Attribs

    MRY_OBJ_ATTRIBUTES &Attribs();
Top
 

TextureSpecific

The function TextureSpecific returns a reference to the texture-specific struct.

    MRY_TEXTURE_DATA &TextureSpecific();

Return Values

A reference to the MRY_TEXTURE_DATA struct.


Top
 

ObjSpecific

The function ObjSpecific returns a reference to the object-specific struct.

    MRY_OBJ_SPECIFIC &ObjSpecific();

Return Values

A reference to the MRY_OBJ_SPECIFIC struct.


Top
 

NEW!LayerInfo

The function LayerInfo returns a reference to the layer info struct.

    MRY_OBJ_LAYERS &GetLayerInfo();

Return Values

A reference to the MRY_OBJ_LAYERS struct.


Top
 

LPMRY_OBJ_ATTRIBUTES

The function LPMRY_OBJ_ATTRIBUTES returns a pointer to the attribute struct.

    operator LPMRY_OBJ_ATTRIBUTES();

Return Values

A pointer to the MRY_OBJ_ATTRIBUTE struct.


Top