Struct MDLLight

Source

#[repr(C)]
pub struct MDLLight { /* private fields */ }

Available on crate features MDLLight and MDLObject only.

Expand description

Apple’s documentation

Implementations§

Source §

impl MDLLight

Source

pub unsafe fn lightType(&self) -> MDLLightType

Source

pub unsafe fn setLightType(&self, light_type: MDLLightType)

Setter for lightType.

Source

pub unsafe fn colorSpace(&self) -> Retained<NSString>

Source

pub unsafe fn setColorSpace(&self, color_space: &NSString)

Setter for colorSpace.

Source §

impl MDLLight

Methods declared on superclass NSObject.

Source

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Source

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = MDLObject>§

Source

pub unsafe fn components( &self, ) -> Retained<NSArray<ProtocolObject<dyn MDLComponent>>>

Available on crate feature MDLTypes only.

Allows applications to introspect the components on the objects.

Source

pub unsafe fn setComponent_forProtocol( &self, component: &ProtocolObject<dyn MDLComponent>, protocol: &AnyProtocol, )

Available on crate feature MDLTypes only.

Extensible component support that allows user of ModelIO to customize MDLObjects to fit their format and workflow.

Source

pub unsafe fn componentConformingToProtocol( &self, protocol: &AnyProtocol, ) -> Option<Retained<ProtocolObject<dyn MDLComponent>>>

Available on crate feature MDLTypes only.

Extensible component support that allows user of ModelIO to customize MDLObjects to fit their format and workflow.

Source

pub unsafe fn objectForKeyedSubscript( &self, key: &AnyProtocol, ) -> Option<Retained<ProtocolObject<dyn MDLComponent>>>

Available on crate feature MDLTypes only.

Allows shorthand [key] syntax for componentConformingToProtocol:.

Parameter key: The protocol that the component conforms to.

See: componentConformingToProtocol:

Source

pub unsafe fn setObject_forKeyedSubscript( &self, obj: Option<&ProtocolObject<dyn MDLComponent>>, key: &AnyProtocol, )

Available on crate feature MDLTypes only.

Allows shorthand [key] syntax for setComponent:forProtocol:.

Parameter key: The protocol that the component conforms to.

See: setComponent:forProtocol:

Source

pub unsafe fn parent(&self) -> Option<Retained<MDLObject>>

Parent object. Nil if no parent.

Set to nil when you remove this from an object container inside the parent object.

Source

pub unsafe fn setParent(&self, parent: Option<&MDLObject>)

This is a weak property. Setter for parent.

Source

pub unsafe fn instance(&self) -> Option<Retained<MDLObject>>

Instance object

nil, unless this object refers to original data to be instanced. The original data object can be any MDLObject that does not have a parent. If an MDLAsset has been created from a data file, any original objects parsed from that file will be found in the originals property. A typical use of a original and instance might be to have one original chair MDLObject, and instance six chairs around a table. The transform of each chair would be found on the parent MDLObject, but the various items making up the chair would be found in the original object.

Source

pub unsafe fn setInstance(&self, instance: Option<&MDLObject>)

Setter for instance.

Source

pub unsafe fn path(&self) -> Retained<NSString>

a string representing a path to the object

a path is of the form /path/to/object where the path is formed by concatenating the names of the objects up the parent chain. Requesting a path will force any unnamed objects to became uniquely named. Any characters outside of [A-Z][a-z][0-9][:-_.] will be forced to underscore.

Source

pub unsafe fn objectAtPath(&self, path: &NSString) -> Retained<MDLObject>

Return the object at the specified path, or nil if none exists there

Source

pub unsafe fn enumerateChildObjectsOfClass_root_usingBlock_stopPointer( &self, object_class: &AnyClass, root: &MDLObject, block: &DynBlock<dyn Fn(NonNull<MDLObject>, NonNull<Bool>)>, stop_pointer: NonNull<Bool>, )

Available on crate feature block2 only.

Source

pub unsafe fn transform( &self, ) -> Option<Retained<ProtocolObject<dyn MDLTransformComponent>>>

Available on crate features MDLTransform and MDLTypes only.

Short hand property for the MDLTransformComponent.

The default value is nil

See: MDLTransformComponent

Source

pub unsafe fn setTransform( &self, transform: Option<&ProtocolObject<dyn MDLTransformComponent>>, )

Available on crate features MDLTransform and MDLTypes only.

Setter for transform.

Source

pub unsafe fn children( &self, ) -> Retained<ProtocolObject<dyn MDLObjectContainerComponent>>

Available on crate feature MDLTypes only.

Short hand property for the MDLObjectContainerComponent.

The default value is an empty MDLObjectContainer

See: MDLObjectContainerComponent

Source

pub unsafe fn setChildren( &self, children: &ProtocolObject<dyn MDLObjectContainerComponent>, )

Available on crate feature MDLTypes only.

Setter for children.

Source

pub unsafe fn hidden(&self) -> bool

Visibility of the node

default is NO

Source

pub unsafe fn setHidden(&self, hidden: bool)

Setter for hidden.

Source

pub unsafe fn addChild(&self, child: &MDLObject)

Short hand for adding a child to the current container component and setting the parent to this object.

It will create a default container if none exists. If children are explicitly disallowed for an object, then add a container component that throws on addition.

See: MDLObjectContainer

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}