public interface Light extends NXObject
Modifier and Type | Interface and Description |
---|---|
static class |
Light.LightTypeData
This class holds the data returned from
getLightType() |
static class |
Light.SceneType
The predefined scene lights used in Basic Lights.
|
NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat
Modifier and Type | Method and Description |
---|---|
boolean |
getEnabledInView(View view)
Whether a light is enabled in a given view.
|
Light.LightTypeData |
getLightType()
Get the type of a light.
|
double |
intensity()
Returns the intensity of a light.
|
void |
setEnabledInView(View view,
boolean onOrOff)
Whether a light is to be enabled in a given view.
|
void |
setIntensity(double intensity)
License requirements: None. |
deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock
printTestData, printTestData, tag, tagValue
findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName
boolean getEnabledInView(View view) throws NXException, RemoteException
view
- The view to checkNXException
RemoteException
void setEnabledInView(View view, boolean onOrOff) throws NXException, RemoteException
LightType.SCENE
.
view
- The view to turn the light on or off inonOrOff
- true for on, false for offNXException
RemoteException
double intensity() throws NXException, RemoteException
setIntensity(double)
may only be used for
a scene light. NXException
RemoteException
void setIntensity(double intensity) throws NXException, RemoteException
intensity
- NXException
RemoteException
Light.LightTypeData getLightType() throws NXException, RemoteException
NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.