CinewarePluginHelper Class Reference

#include <cineware_messages.h>

Static Public Member Functions
static MAXON_METHOD Bool	IsFromHost (const cinema::BaseList2D *object)
static MAXON_METHOD UniqueHash	GetHostID (const cinema::BaseList2D *object)
static MAXON_METHOD UniqueHash	GetScatterUniqueHashCode (const ScatteredInstanceInfo &instanceInfo)
static MAXON_METHOD maxon::String	GetHostName ()
static MAXON_METHOD void	SetHostApplicationID (Int32 appID)
static MAXON_METHOD Bool	IsHostVectorworks ()
static MAXON_METHOD Bool	IsHostRevit ()
static MAXON_METHOD Bool	IsHostArchicad ()
static MAXON_METHOD Bool	IsHostLayer (const cinema::BaseObject *obj)
static MAXON_METHOD Bool	IsHostClass (const cinema::BaseObject *obj)
static MAXON_METHOD Bool	IsRedshiftLayer (const cinema::BaseObject *obj)
static MAXON_METHOD Bool	IsRedshiftObjectClass (const cinema::BaseObject *obj)
static MAXON_METHOD Bool	IsRedshiftScatterClass (const cinema::BaseObject *obj)
static MAXON_METHOD Bool	ShowActiveLayerWarningIfNeeded (const cinema::BaseList2D *ml)
static MAXON_METHOD Bool	IsHostActiveLayer (const cinema::BaseObject *obj)
static MAXON_METHOD void	SetActiveLayerID (const UniqueHash &AecEntityHash)
static MAXON_METHOD Bool	SendMxAnalyticsEvent (const maxon::String &eventname, const maxon::DataDictionary &eventParams)

Private Member Functions
	MAXON_INTERFACE_NONVIRTUAL (CinewarePluginHelper, MAXON_REFERENCE_STATIC, "net.maxon.interfaces.cinewarepluginhelper")

Member Function Documentation

MAXON_INTERFACE_NONVIRTUAL()

MAXON_INTERFACE_NONVIRTUAL ( CinewarePluginHelper  , MAXON_REFERENCE_STATIC  , "net.maxon.interfaces.cinewarepluginhelper"    )

private

IsFromHost()

static MAXON_METHOD Bool IsFromHost ( const cinema::BaseList2D *  object )

static

Check if the object has a AEC id defined by the host.

Parameters

[in]

object

The object where the ID should be retrieve and compare to 0.

Returns

True if the ID is defined and different than 0. It means the object is coming from an AEC host.

GetHostID()

static MAXON_METHOD UniqueHash GetHostID ( const cinema::BaseList2D *  object )

static

Retrieve the AEC Unique ID defined by the plugin host. If the ID cannot be retrieve using CINEWARE_GENERIC_APP_ID it will send a message to the plugin.

Parameters

[in]

object

The object where the ID should be retrieve.

Returns

Hash code of the given object.

GetScatterUniqueHashCode()

static MAXON_METHOD UniqueHash GetScatterUniqueHashCode ( const ScatteredInstanceInfo &  instanceInfo )

static

Generate hash including dirty data of the asset object.

GetHostName()

static MAXON_METHOD maxon::String GetHostName ( )

static

SetHostApplicationID()

static MAXON_METHOD void SetHostApplicationID ( Int32  appID )

static

IsHostVectorworks()

static MAXON_METHOD Bool IsHostVectorworks ( )

static

IsHostRevit()

static MAXON_METHOD Bool IsHostRevit ( )

static

IsHostArchicad()

static MAXON_METHOD Bool IsHostArchicad ( )

static

IsHostLayer()

static MAXON_METHOD Bool IsHostLayer ( const cinema::BaseObject *  obj )

static

IsHostClass()

static MAXON_METHOD Bool IsHostClass ( const cinema::BaseObject *  obj )

static

IsRedshiftLayer()

static MAXON_METHOD Bool IsRedshiftLayer ( const cinema::BaseObject *  obj )

static

IsRedshiftObjectClass()

static MAXON_METHOD Bool IsRedshiftObjectClass ( const cinema::BaseObject *  obj )

static

IsRedshiftScatterClass()

static MAXON_METHOD Bool IsRedshiftScatterClass ( const cinema::BaseObject *  obj )

static

ShowActiveLayerWarningIfNeeded()

static MAXON_METHOD Bool ShowActiveLayerWarningIfNeeded ( const cinema::BaseList2D *  ml )

static

Show a warning message if the user is trying to hide a layer that is the active layer in the host application.

Parameters

[in]

ml

The object to check.

Returns

True if the warning message was shown, false if it was not needed.

IsHostActiveLayer()

static MAXON_METHOD Bool IsHostActiveLayer ( const cinema::BaseObject *  obj )

static

Checks if the object passed as parameter is the current active layer in the host application.

Parameters

[in]

obj

The object to check.

Returns

True if the object is the active layer in the host application.

SetActiveLayerID()

static MAXON_METHOD void SetActiveLayerID ( const UniqueHash &  AecEntityHash )

static

Define the ID of the active layer in the host application if the host application support the concept of active layer.

Parameters

[in]

AecEntityHash

The hash of the current active layer that is activated.

SendMxAnalyticsEvent()

static MAXON_METHOD Bool SendMxAnalyticsEvent ( const maxon::String &  eventname, const maxon::DataDictionary &  eventParams  )

static

Required to send MxAnalytics Events from plugin side.