11 #ifndef __BRAY_Interface__
12 #define __BRAY_Interface__
42 class BRAY_ShaderGraph;
43 class BRAY_ShaderInstance;
44 class BRAY_VexMaterial;
83 bool isValid()
const {
return mySpace.get() !=
nullptr; }
94 int motionSegments()
const;
127 bool canErase(
int token)
const;
134 bool isValid()
const {
return myOptions.get() !=
nullptr; }
142 exint numProperties()
const;
158 template <
typename T>
159 const T *
import(
int token,
T *
val,
size_t n)
const;
168 template <
typename T>
169 bool set(
int token,
const T *
value,
exint tuple_size);
172 template <
typename T>
175 return set(token, &value, 1);
179 template <
typename T>
180 bool isEqual(
int token,
const T *
value,
exint tuple_size)
const;
183 template <
typename T>
186 return isEqual(token, &value, 1);
190 bool isVariadic(
int token)
const;
206 const bool *bval(
int token)
const;
207 const int64 *ival(
int token)
const;
208 const fpreal64 *fval(
int token)
const;
235 static void setExitOnFailedLicense(
bool state=
true);
242 bool isKarmaCPU()
const;
243 bool isKarmaXPU()
const;
249 bool isValid()
const {
return myScene.get() !=
nullptr; }
252 bool threadSafe()
const;
255 bool nestedInstancing()
const;
280 void saveCheckpointASAP();
305 const BRAY_Scene *
scenePtr()
const {
return myScene.get(); }
310 void commitOptions();
315 const OptionSet constSceneOptions()
const;
321 const OptionSet constObjectProperties()
const;
327 const OptionSet constLightProperties()
const;
332 const OptionSet constCameraProperties()
const;
337 const OptionSet constPlaneProperties()
const;
347 template <
typename T>
349 T *
val,
size_t n)
const
351 return constSceneOptions().import(token, val, n);
355 template <
typename T>
360 return sceneOptions().set(token, value, tuple_size);
364 template <
typename T>
368 return setOption(token, &value, 1);
375 return constSceneOptions().size(token);
382 return constSceneOptions().storage(token);
389 return constSceneOptions().isVariadic(token);
392 {
return *constSceneOptions().bval(t); }
394 {
return *constSceneOptions().ival(t); }
396 {
return *constSceneOptions().fval(t); }
398 {
return *constSceneOptions().sval(t); }
404 template <
typename T>
406 T *
val,
size_t n)
const
408 return constObjectProperties().import(token, val, n);
412 template <
typename T>
417 return objectProperties().set(token, value, tuple_size);
434 {
return lockProperties(
"*", state); }
437 template <
typename T>
441 return setProperty(token, &value, 1);
448 return constObjectProperties().size(token);
455 return constObjectProperties().storage(token);
462 return constObjectProperties().isVariadic(token);
465 {
return *constObjectProperties().bval(t); }
467 {
return *constObjectProperties().ival(t); }
469 {
return *constObjectProperties().fval(t); }
471 {
return *constObjectProperties().sval(t); }
533 bool loadHDA(
const char *
path);
554 : myGeometry(primvar)
555 , myParmName(shader_parm)
558 , myIsArray(is_array)
581 bool isValid()
const {
return myMat !=
nullptr; }
590 void updateSurface(
const ScenePtr &scene,
594 bool updateDisplace(
ScenePtr &scene,
599 void updateSurfaceCode(
const ScenePtr &scene,
606 bool updateDisplaceCode(
const ScenePtr &scene,
612 void updateSurfaceGraph(
const ScenePtr &scene,
617 bool updateDisplaceGraph(
ScenePtr &scene,
622 void setInputs(
const ScenePtr &scene,
629 void setCoordSysAliases(
const ScenePtr &scene,
633 BRAY_VexMaterial *myMat;
640 : myFaceList(facelist)
641 , myMaterial(material)
655 bool isValid()
const {
return myObject !=
nullptr; }
663 const BRAY_Object *
objectPtr()
const {
return myObject.get(); }
676 void setInstancePrototype(
const ObjectPtr &proto);
679 void setInstanceTransforms(
ScenePtr &scene,
683 void setInstanceAttributes(
const ScenePtr &scene,
690 void setInstanceProperties(
const ScenePtr &scene,
701 bool validateInstance()
const;
719 bool setGeometry(
const ScenePtr &scene,
724 bool setGeometry(
const ScenePtr &scene,
739 void takeOwnership(BRAY_Object *obj);
756 bool isValid()
const {
return myLight !=
nullptr; }
761 const BRAY_Light *
lightPtr()
const {
return myLight.get(); }
769 void setTransform(
const SpacePtr &xforms);
781 void commitOptions(
ScenePtr &scene);
784 void updateShaderGraph(
const ScenePtr &scene,
791 void updateFilters(
const ScenePtr &scene,
795 void eraseFilter(
const ScenePtr &scene,
812 bool isValid()
const {
return myCamera !=
nullptr; }
817 const BRAY_Camera *
cameraPtr()
const {
return myCamera.get(); }
833 void resizeCameraProperties(
int nseg);
839 void commitOptions(
ScenePtr &scene);
856 bool isValid()
const {
return mySpace !=
nullptr; }
862 const BRAY_Camera *
spacePtr()
const {
return mySpace.get(); }
878 void resizeCameraProperties(
int nseg);
902 {
return aov.myAOVBuffer == myAOVBuffer; }
904 {
return !(*
this == aov); }
913 float getDefaultValue()
const;
917 bool isMapped()
const;
920 int getNumExtra()
const;
924 void *mapExtra(
int idx);
925 void unmapExtra(
int idx);
930 bool isConverged()
const;
932 void clearConverged();
935 bool isValid()
const;
965 template <
typename T>
969 template <
typename T>
971 {
return setOption(name, &value, 1); }
989 , myFilename(filename)
1006 template <
typename T>
1010 template <
typename T>
1012 {
return setOption(name, &value, 1); }
1021 myAOVs.emplace_back(name);
1022 return myAOVs.last();
1028 bool result = doCommit();
1081 void clearOutputPlanes();
1083 int getAOVCount()
const;
1093 bool prepareRender();
1096 void render(
bool (*stopreq)(
void *) =
nullptr,
void *
data =
nullptr);
1099 bool isRendering()
const;
1102 bool isError()
const;
1105 bool isPaused()
const;
1108 void prepareForStop();
1114 bool resumeRender();
1117 void setPriority(
int x,
int y);
1123 void clearPriority();
1128 bool enableImageFilters(
1130 bool is_render_settings_prim);
1133 void setUseRenderSettingsPrim(
bool use_render_settings_prim);
1136 BRAY_Renderer *renderer() {
return myRenderer.get(); }
1159 OptionSet nodeParams(BRAY_ShaderInstance *node);
1183 bool isInt()
const {
return myType == 1; }
1191 return myB.size() + myI.size() + myF.size() + myS.size();
1209 {
return myInputs; }
1211 {
return myOutputs; }
1213 {
return myMetadata; }
1218 { myInputs.append(parm); }
1220 { myOutputs.append(parm); }
1222 { myMetadata = metadata; }
1241 const OptionSet getObjectProperties()
const;
1245 void clearObjectProperties();
void cancel()
Cancel this output file for some reason.
BRAY_EventType
Types of events that can be sent as updates to the renderer.
AOV & appendAOV(const UT_StringHolder &name)
Add an AOV to this output file.
UT_StringHolder optionS(BRAY_SceneOption t) const
int64 propertyI(BRAY_SceneOption t) const
GT_API const UT_StringHolder filename
const BRAY_Camera * spacePtr() const
Interface to scene materials.
const VPRM_SpacePtr & space() const
bool operator==(const AOVBufferPtr &aov) const
SYS_FORCE_INLINE const T * propertyImport(BRAY_ObjectProperty token, T *val, size_t n) const
const BRAY_Scene * scenePtr() const
bool commit()
Commit and add this output file to the render.
const BRAY_Camera * cameraPtr() const
void setName(const UT_StringHolder &n)
void addOutput(const Parameter &parm)
bool isValid() const
Test validity.
float BRAYtime
Consistent representation of time type within BRAY.
getFileOption("OpenEXR:storage") storage
bool operator!=(const AOVBufferPtr &aov) const
SYS_FORCE_INLINE bool setProperty(BRAY_ObjectProperty token, const T &value)
Simple interface to set a scalar property.
GLsizei const GLchar *const * path
AOV(const UT_StringHolder &name)
UT_SharedPtr< BRAY_Light > myLight
FacesetMaterial(const GT_DataArrayHandle &facelist=GT_DataArrayHandle(), const MaterialPtr &material=MaterialPtr())
const UT_Options & options() const
const UT_StringMap< UT_StringHolder > & metadata() const
CoordSysPtr(const UT_SharedPtr< BRAY_Camera > &sp=UT_SharedPtr< BRAY_Camera >())
const UT_Array< AOV > & aovs() const
const UT_StringHolder & name() const
SYS_FORCE_INLINE const T * optionImport(BRAY_SceneOption token, T *val, size_t n) const
const UT_StringHolder & filename() const
Access member data.
bool setOption(const UT_StringHolder &name, const T &value)
Class which writes ASCII or binary JSON streams.
int64 optionI(BRAY_SceneOption t) const
**But if you need a result
SYS_FORCE_INLINE bool set(int token, const T &value)
Simple interface to set a scalar property.
const BRAY_Object * objectPtr() const
SYS_FORCE_INLINE exint propertySize(BRAY_ObjectProperty token) const
const UT_Array< Parameter > & inputs() const
const BRAY_Light * lightPtr() const
OutputFile(BRAY::ScenePtr &scene, const UT_StringHolder &filename, const UT_StringHolder &type)
bool isValid() const
Test validity.
CameraPtr(const UT_SharedPtr< BRAY_Camera > &cp=UT_SharedPtr< BRAY_Camera >())
IFDmantra you can see code vm_image_mplay_direction endcode When SOHO starts a render
const BRAY_VexMaterial * materialPtr() const
GLintptr GLsizeiptr GLboolean commit
SYS_FORCE_INLINE bool isEqual(int token, const T &value) const
Simple interface for equality of a scalar value.
UT_StringHolder propertyS(BRAY_SceneOption t) const
std::unique_ptr< T, Deleter > UT_UniquePtr
A smart pointer for unique ownership of dynamically allocated objects.
bool isValid() const
Test validity.
bool propertyB(BRAY_SceneOption t) const
VPRM_OptionSetPtr & options()
const UT_StringHolder name() const
SYS_FORCE_INLINE GT_Storage propertyStorage(BRAY_ObjectProperty token) const
Return the storage class of an option.
UT_SharedPtr< BRAY_Camera > myCamera
BRAY_RayVisibility
Ray visibility flags.
UT_SharedPtr< BRAY_Object > myObject
UT_Array< UT_StringHolder > myS
BRAY_Camera * cameraPtr()
std::shared_ptr< T > UT_SharedPtr
Wrapper around std::shared_ptr.
UT_IntrusivePtr< GT_DataArray > GT_DataArrayHandle
SYS_FORCE_INLINE exint optionSize(BRAY_SceneOption token) const
PXL_API const char * getName(const ColorSpace *space)
Return the name of the color space.
void setMetadata(const UT_StringMap< UT_StringHolder > &metadata)
ShaderGraphPtr(UT_SharedPtr< BRAY_ShaderGraph > graph)
UT_StringHolder myVariable
NodeDecl(const UT_StringHolder &n)
SYS_FORCE_INLINE bool optionIsVariadic(BRAY_SceneOption token) const
Return whether an option has variadic arguments.
SYS_FORCE_INLINE bool setOption(BRAY_SceneOption token, const T *value, exint tuple_size)
Interface to set an option. This template class is specialized for:
SYS_FORCE_INLINE exint lockAllObjectProperties(bool state)
Lock or unlock all object properties.
const UT_Array< Parameter > & outputs() const
bool isValid() const
Test validity.
Class used to define image planes.
GLuint const GLchar * name
const UT_Options & options() const
GT_DataArrayHandle myFaceList
SYS_FORCE_INLINE bool setOption(BRAY_SceneOption token, const T &value)
Simple interface to set a scalar option.
PXL_DataFormat myDataFormat
A map of string to various well defined value types.
A render product represents an output file.
fpreal64 optionF(BRAY_SceneOption t) const
MaterialPtr(BRAY_VexMaterial *mat=nullptr)
VULKAN_HPP_NODISCARD VULKAN_HPP_INLINE Result createInstance(const VULKAN_HPP_NAMESPACE::InstanceCreateInfo *pCreateInfo, const VULKAN_HPP_NAMESPACE::AllocationCallbacks *pAllocator, VULKAN_HPP_NAMESPACE::Instance *pInstance, Dispatch const &d) VULKAN_HPP_NOEXCEPT
SYS_FORCE_INLINE bool setProperty(BRAY_ObjectProperty token, const T *value, exint tuple_size)
Interface to set an property. This template class is specialized for:
AOVBufferPtr(const UT_SharedPtr< BRAY_AOVBuffer > &aov)
SYS_FORCE_INLINE bool propertyIsVariadic(BRAY_ObjectProperty token) const
Return whether an property has variadic arguments.
bool isValid() const
Test validity.
**If you just want to fire and args
void addInput(const Parameter &parm)
GLubyte GLubyte GLubyte GLubyte w
bool setOption(const UT_StringHolder &name, const T &value)
MX_GENSHADER_API const TypeDesc * INTEGER
std::shared_ptr< class ShaderMaterial > MaterialPtr
bool optionB(BRAY_SceneOption t) const
Interface to the renderer.
const UT_StringHolder & type() const
fpreal64 propertyF(BRAY_SceneOption t) const
const VPRM_OptionSetPtr & options() const
BRAY_Object * objectPtr()
LightPtr(const UT_SharedPtr< BRAY_Light > &lp=UT_SharedPtr< BRAY_Light >())
SYS_FORCE_INLINE GT_Storage optionStorage(BRAY_SceneOption token) const
Return the storage class of an option.
FMT_CONSTEXPR auto find(Ptr first, Ptr last, T value, Ptr &out) -> bool